Функция NetLocalGroupSetInfo (lmaccess.h)

Статья
08/24/2023

Функция NetLocalGroupSetInfo изменяет имя существующей локальной группы. Функция также связывает комментарий с локальной группой.

Синтаксис

NET_API_STATUS NET_API_FUNCTION NetLocalGroupSetInfo(
  [in]  LPCWSTR servername,
  [in]  LPCWSTR groupname,
  [in]  DWORD   level,
  [in]  LPBYTE  buf,
  [out] LPDWORD parm_err
);

Параметры

[in] servername

Указатель на константную строку, указывающую DNS- или NetBIOS-имя удаленного сервера, на котором выполняется функция. Если этот параметр имеет значение NULL, используется локальный компьютер.

[in] groupname

Указатель на константную строку, указывающую имя учетной записи локальной группы для изменения. Дополнительные сведения см. в разделе "Примечания".

[in] level

Указывает уровень информации о данных. Этот параметр может принимать одно из указанных ниже значений.

Значение	Значение
0	Указывает имя локальной группы. Параметр buf указывает на LOCALGROUP_INFO_0 структуру. Используйте этот уровень для изменения имени существующей локальной группы.
1	Указывает имя локальной группы и комментарий для связи с группой. Параметр buf указывает на структуру LOCALGROUP_INFO_1 .
1002	Указывает комментарий для связи с локальной группой. Параметр buf указывает на структуру LOCALGROUP_INFO_1002 .

[in] buf

Указатель на буфер, содержащий сведения о локальной группе. Формат этих данных зависит от значения параметра level . Дополнительные сведения см. в разделе Буферы функций управления сетью.

[out] parm_err

Указатель на значение, которое получает индекс первого члена информационной структуры локальной группы, вызвавшего ошибку ERROR_INVALID_PARAMETER. Если этот параметр имеет значение NULL, индекс не возвращается при ошибке. Дополнительные сведения см. в разделе "Примечания".

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение будет NERR_Success.

Если функция завершается сбоем, возвращаемое значение может быть одним из следующих кодов ошибок.

Код возврата	Описание
ERROR_ACCESS_DENIED	У пользователя нет доступа к запрошенной информации.
ERROR_INVALID_PARAMETER	Один из параметров функции недопустим. Дополнительные сведения см. в разделе "Примечания".
ERROR_NO_SUCH_ALIAS	Указанная локальная группа не существует.
NERR_NotPrimary	Операция разрешена только на основном контроллере домена.
NERR_InvalidComputer	Недопустимое имя компьютера.

Если вы вызываете эту функцию на контроллере домена под управлением Active Directory, доступ разрешен или запрещен на основе списка управления доступом (ACL) для защищаемого объекта. ACL по умолчанию разрешает вызывать эту функцию только администраторам домена и операторам учетных записей. На рядовом сервере или рабочей станции эту функцию могут вызывать только администраторы и опытные пользователи. Дополнительные сведения см. в разделе Требования к безопасности для функций управления сетью. Дополнительные сведения о списках управления доступом, ACE и маркерах доступа см. в разделе модель контроль доступа.

Дескриптор безопасности объекта LocalGroup используется для выполнения проверка доступа для этой функции. Как правило, вызывающие объекты должны иметь доступ на запись ко всему объекту для успешного выполнения вызовов этой функции.

Чтобы указать новое имя существующей локальной группы, вызовите NetLocalGroupSetInfo с LOCALGROUP_INFO_0 и укажите значение с помощью элемента lgrpi0_name . Если вызвать функцию NetLocalGroupSetInfo с LOCALGROUP_INFO_1 и указать новое значение с помощью элемента lgrpi1_name , это значение будет игнорироваться.

Если функция NetLocalGroupSetInfo возвращает ERROR_INVALID_PARAMETER, можно использовать параметр parm_err , чтобы указать, что первый член информационной структуры локальной группы является недопустимым. (Информационная структура локальной группы начинается с LOCALGROUP_INFO_ и ее формат задается параметром уровня .) В следующей таблице перечислены значения, которые могут быть возвращены в параметре parm_err , и соответствующий элемент структуры, который находится в ошибке. (Префикс lgrpi*_ указывает, что элемент может начинаться с нескольких префиксов, например lgrpi0_ или lgrpi1_.)

Значение	Член
LOCALGROUP_NAME_PARMNUM	lgrpi*_name
LOCALGROUP_COMMENT_PARMNUM	lgrpi*_comment

Имена учетных записей пользователей ограничены 20 символами, а имена групп — 256 символами. Кроме того, имена учетных записей не могут быть завершены точкой и не могут содержать запятые или какие-либо из следующих печатных символов: ", /, , [, ], :, |, <, >, +, =, ;, ?, *. Имена также не могут содержать символы в диапазоне от 1 до 31, которые не могут быть печатными.

При программировании для Active Directory вы можете вызвать определенные методы интерфейса службы Active Directory (ADSI) для достижения тех же функциональных возможностей, которые можно достичь, вызвав функции локальной группы управления сетью. Дополнительные сведения см. в разделе IADsGroup.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	lmaccess.h (включая Lm.h)
Библиотека	Netapi32.lib
DLL	Netapi32.dll