NetGroupEnum
The NetGroupEnum
function retrieves information about each global group account.
Security Requirements
Only members
of the Administrators or Account Operators local group can successfully execute
NetGroupEnum.
NET_API_STATUS NetGroupEnum(
|
LPWSTR servername, |
|
|
DWORD level, |
|
|
LPBYTE *bufptr, |
|
|
DWORD prefmaxlen, |
|
|
LPDWORD entriesread, |
|
|
LPDWORD totalentries, |
|
|
LPDWORD resume_handle
|
|
|
); |
|
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.
level
Specifies one
of the following values to return the level of information pointed to in the bufptr
parameter.
|
Value |
Meaning |
|
0 |
Return
group name. The returned buffer points to an array of GROUP_INFO_0 structures. |
|
1 |
Return
group name and comment. The returned buffer points to an array of GROUP_INFO_1 structures. |
|
2 |
Return
information about the group. The returned buffer points to an array of GROUP_INFO_2 structures. |
bufptr
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.
resume_handle
Pointer to a DWORD
that contains a resume_handle, which is used to continue an existing
global group search. The handle should be zero on the first call and left
unchanged for subsequent calls. If resume_handle is NULL, then no resume
handle is stored.
Remarks
The NetQueryDisplayInformation function provides a very
efficient mechanism for enumerating global group accounts. When possible, use
that function instead of NetGroupEnum.
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_MORE_DATA |
More
entries are available with subsequent calls. |
See Also