NetGroupGetUsers 函数 (lmaccess.h)

项目
08/24/2023

NetGroupGetUsers 函数检索安全数据库中特定全局组中的成员列表，该组是安全帐户管理器 (SAM) 数据库，如果是域控制器，则为 Active Directory。

语法

NET_API_STATUS NET_API_FUNCTION NetGroupGetUsers(
  [in]      LPCWSTR    servername,
  [in]      LPCWSTR    groupname,
  [in]      DWORD      level,
  [out]     LPBYTE     *bufptr,
  [in]      DWORD      prefmaxlen,
  [out]     LPDWORD    entriesread,
  [out]     LPDWORD    totalentries,
  [in, out] PDWORD_PTR ResumeHandle
);

parameters

[in] servername

指向常量字符串的指针，该字符串指定要对其执行函数的远程服务器的 DNS 或 NetBIOS 名称。如果此参数为 NULL，则使用本地计算机。

[in] groupname

指向常量字符串的指针，该常量字符串指定要列出其成员的全局组的名称。有关更多信息，请参见下面的“备注”部分。

[in] level

请求的数据的信息级别。此参数的取值可为下列值之一：

值	含义
0	返回全局组的成员名称。 bufptr 参数指向GROUP_USERS_INFO_0结构的数组。
1	返回全局组的成员名称和属性。 bufptr 参数指向GROUP_USERS_INFO_1结构的数组。

[out] bufptr

指向接收信息结构的缓冲区地址的指针。系统为此缓冲区分配内存。必须调用 NetApiBufferFree 函数才能解除分配内存。请注意，即使函数因ERROR_MORE_DATA而失败，也必须释放缓冲区。

[in] prefmaxlen

返回数据的首选最大长度（以字节为单位）。如果指定MAX_PREFERRED_LENGTH，函数将分配保存数据所需的内存量。如果在此参数中指定另一个值，它可以限制函数返回的字节数。如果缓冲区大小不足以容纳所有条目，则函数将返回ERROR_MORE_DATA。有关详细信息，请参阅网络管理功能缓冲区和网络管理功能缓冲区长度。

[out] entriesread

指向一个值的指针，该值接收实际枚举的元素计数。

[out] totalentries

指向一个值的指针，该值接收可能从当前恢复位置枚举的条目总数。

[in, out] ResumeHandle

指向变量的指针，该变量包含用于继续现有用户枚举的恢复句柄。第一次调用时，句柄应为零，后续调用应保持不变。如果 ResumeHandle 参数为 NULL，则不存储任何恢复句柄。

返回值

如果函数成功，则返回值NERR_Success。

如果函数失败，则返回值可能是以下错误代码之一。

返回代码	说明
ERROR_ACCESS_DENIED	用户无权访问请求的信息。
ERROR_INVALID_LEVEL	系统调用级别不正确。如果将级别参数指定为 0 或 1 以外的值，则返回此错误。
ERROR_MORE_DATA	有更多条目可用。指定一个足够大的缓冲区来接收所有条目。
ERROR_NOT_ENOUGH_MEMORY	内存不足，无法完成操作。
NERR_InvalidComputer	计算机名称无效。
NERR_GroupNotFound	找不到 bufptr 参数指向的结构中的全局组名称。
NERR_InternalError	发生内部错误。

注解

如果在运行 Active Directory 的域控制器上调用此函数，则会根据安全对象的访问控制列表 (ACL) 来允许或拒绝访问。默认 ACL 允许所有经过身份验证的用户和“Windows 2000 前兼容访问”组的成员查看信息。如果在成员服务器或工作站上调用此函数，则所有经过身份验证的用户都可以查看信息。有关这些平台上的匿名访问和限制匿名访问的信息，请参阅网络管理功能的安全要求。有关 ACL、ACE 和访问令牌的详细信息，请参阅访问控制模型。

Group 对象的安全描述符用于执行此函数的访问检查。

若要在现有全局组中授予一个用户成员身份，可以调用 NetGroupAddUser 函数。若要从全局组中删除用户，请调用 NetGroupDelUser 函数。有关替换全局组的成员身份的信息，请参阅 NetGroupSetUsers。

用户帐户名称限制为 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