NetUserGetLocalGroups

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 NetUserGetLocalGroups function retrieves a list of local groups to which a specified user belongs.

Security Requirements
Only members of the Administrators or Account Operators local group can successfully execute NetUserGetLocalGroups.
NET_API_STATUS NetUserGetLocalGroups(

LPWSTR servername,
LPWSTR username,
DWORD level,
DWORD flags,
LPBYTE *bufptr,
DWORD prefmaxlen,
LPDWORD entriesread,
LPDWORD totalentries
);

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.

username
Pointer to a Unicode string containing the name of the user for which to return global group membership. This parameter can be of the form <UserName>, in which case the username is expected to be found on servername. The user name can also be of the form <DomainName>\<UserName> in which case <DomainName> is associated with servername and <UserName> is expected to be to be found on that domain.

level
Level of information required. Only 0 is valid.

flags
Bitmask of flags. Currently, only LG_INCLUDE_INDIRECT is defined. If this bit is set, the function will also return the local groups of which the user is indirectly a member (that is, by the virtue of being in a global group that itself is a member of one or more local groups).

bufptr
On return a pointer to the return information structure is returned in the address pointed to by bufptr. The returned information is an array of LOCALGROUP_USERS_INFO_0 structures. 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.

Return Values
If the function is successful, it returns 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_UserNotFound	The user name could not be found.