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

指向包含本地组信息的缓冲区的指针。此数据的格式取决于级别参数的值。有关详细信息，请参阅网络管理功能缓冲区。

[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 仅允许域管理员和帐户操作员调用此函数。在成员服务器或工作站上，只有管理员和高级用户可以调用此函数。有关详细信息，请参阅网络管理功能的安全要求。有关 ACL、ACE 和访问令牌的详细信息，请参阅访问控制模型。

LocalGroup 对象的安全描述符用于执行此函数的访问检查。通常，调用方必须对整个对象具有写入访问权限，才能成功调用此函数。

若要指定现有本地组的新名称，请使用 LOCALGROUP_INFO_0 调用 NetLocalGroupSetInfo，并使用 lgrpi0_name 成员指定值。如果使用 LOCALGROUP_INFO_1 调用 NetLocalGroupSetInfo 函数并使用 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
标头	lmaccess.h (包括 Lm.h)
Library	Netapi32.lib
DLL	Netapi32.dll