NetGroupGetUsers

Overview

Group

Quick Info

Windows NT
Yes
Win95
No
Win32s
No
Import Library
netapi32.lib
Header File
lmaccess.h
Unicode
WinNT
Platform Notes
All LanMan APIs are UNICODE only

The NetGroupGetUsers function retrieves a list of the members of a particular global group in the security database.

Security Requirements
Only members of the Administrators or Account Operators local group can successfully execute NetGroupGetUsers, except when the request is made by a user who has membership in the specified global group, in which case no special group membership is required.

NET_API_STATUS NetGroupGetUsers(

LPWSTR servername,
LPWSTR groupname,
DWORD level,
LPBYTE *bufptr,
DWORD prefmaxlen,
LPDWORD entriesread,
LPDWORD totalentries,
LPDWORD resumeHandle
);

Parameters
servername
Pointer to a Unicode string containing the name of the remote server on which the function is to execute. A NULL pointer or string specifies the local computer.

groupname
Pointer to a Unicode string containing the name of the global group whose members are to be listed.

level
Specifies one of the following values to return the level of information pointed to in the bufptr parameter.

Value	Meaning
0	Return the group name. The returned buffer points to an array of GROUP_USERS_INFO_0 structures.
	Return the group attributes. The returned buffer points to an array of GROUP_USERS_INFO_1 structures.

bufptr
On return a pointer to the return information structure is returned in the address pointed to by bufptr. The returned buffer should be deallocated using NetApiBufferFree.

prefmaxlen
Preferred maximum length, in 8-bit bytes of returned data.

entriesread
Pointer to a DWORD that contains the actual enumerated element count.

totalentries
Pointer to a DWORD that contains the total number of entries that could have been enumerated from the current resume position.

resumeHandle
Pointer to a DWORD that contains resumeHandle, which is used to continue an existing user group search. The handle should be zero on the first call and left unchanged for subsequent calls. If resumeHandle is NULL, then no resume handle is stored.

Return Values
If the function succeeds, the return value is NERR_Success.

If the function fails, the return value is one of the following error codes.

Value	Meaning
ERROR_ACCESS_DENIED	The user does not have access to the requested information.
NERR_InvalidComputer	The computer name is invalid.
NERR_GroupNotFound	The group name could not be found.
ERROR_MORE_DATA	More entries are available with subsequent calls.