NetLocalGroupEnum
The NetLocalGroupEnum
function retrieves information about each local group account.
Security Requirements
Only members
of the Administrators or Account Operators local group can successfully execute
NetLocalGroupEnum.
NET_API_STATUS NetLocalGroupEnum(
|
LPWSTR servername, |
|
|
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.
level
Specifies one
of the following values to return the level of information pointed to in the bufptr
parameter.
|
Value |
Meaning |
|
0 |
Return the
local group name of the user. The returned buffer points to an array of LOCALGROUP_INFO_0 structures. |
|
1 |
Return
local group attributes of the user. The returned buffer points to an array of
LOCALGROUP_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 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 a resumehandle, which is used to continue an existing
local 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_MORE_DATA
|
More
entries are available with subsequent calls. |
See Also