NetLocalGroupGetMembers
The NetLocalGroupGetMembers
function retrieves a list of the members of a particular local group in the
security database.
Security Requirements
Only members
of the Administrators or Account Operators local group can successfully execute
NetLocalGroupGetMembers. However, when the request is made by a user who
has membership in the specified local group, in no special group membership is
required.
NET_API_STATUS NetLocalGroupGetMembers(
|
LPWSTR servername, |
|
|
LPWSTR localgroupname, |
|
|
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.
localgroupname
Pointer to a
Unicode string containing the name of the local group whose members are to be
listed.
level
Specifies one
of the following values to return the levels of information provided.
|
Value |
Meaning |
|
0 |
The bufptr
parameter points to an array of LOCALGROUP_MEMBERS_INFO_0 structures. |
|
1 |
The bufptr
parameter points to an array of LOCALGROUP_MEMBERS_INFO_1 structures. |
|
2 |
The bufptr
parameter points to an array of LOCALGROUP_MEMBERS_INFO_2 structures. |
|
3 |
The bufptr
parameter points to an array of LOCALGROUP_MEMBERS_INFO_3 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 the
NetApiBufferFree
function.
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. |
|
ERROR_NO_SUCH_ALIAS
|
The alias
group does not exist. |
See Also