Platform SDK: Network Management

NetGroupEnum

The NetGroupEnum function retrieves information about each global group in the security database.

The NetQueryDisplayInformation function provides an efficient mechanism for enumerating global groups. When possible, it is recommended that you use NetQueryDisplayInformation instead of the NetGroupEnum function.

Security Requirements

Windows NT: No special group membership is required to successfully execute the NetGroupEnum function.

Windows 2000: If you call this function on a Windows 2000 domain controller that is running Active Directory, access is allowed or denied based on the access-control list (ACL) for the securable object. The default ACL permits all authenticated users and members of the "Pre-Windows 2000 compatible access" group to view the information. By default, the "Pre-Windows 2000 compatible access" group includes Everyone as a member. This enables anonymous access to the information if the system allows anonymous access.

If you call this function on a Windows 2000 member server or workstation, all authenticated users can view the information. Anonymous access is also permitted if the RestrictAnonymous policy setting allows anonymous access.

For more information about restricting anonymous access, see Security Requirements for the Network Management Functions.

NET_API_STATUS NetGroupEnum(
  LPCWSTR servername,       
  DWORD level,              
  LPBYTE *bufptr,           
  DWORD prefmaxlen,         
  LPDWORD entriesread,      
  LPDWORD totalentries,     
  PDWORD_PTR resume_handle  
);

Parameters

servername

[in] Pointer to a constant null-terminated Unicode character string specifying the name of the remote server on which the function is to execute. The string must begin with \\. If this parameter is NULL, the local computer is used.

level

[in] Specifies the information level of the data. This parameter can be one of the following values.

Value	Meaning
0	Return the global group name. The bufptr parameter points to an array of GROUP_INFO_0 structures.
1	Return the global group name and a comment. The bufptr parameter points to an array of GROUP_INFO_1 structures.
2	Return detailed information about the global group. The bufptr parameter points to an array of GROUP_INFO_2 structures.

bufptr

[out] Pointer to the buffer to receive the global group information structure. The format of this data depends on the value of the level parameter.

The system allocates the memory for this buffer. You must call the NetApiBufferFree function to deallocate the memory. Note that you must free the buffer even if the function fails with ERROR_MORE_DATA.

prefmaxlen

[in] Specifies the preferred maximum length of the returned data, in bytes. If you specify MAX_PREFERRED_LENGTH, the function allocates the amount of memory required to hold the data. If you specify another value in this parameter, it can restrict the number of bytes that the function returns. If the buffer size is insufficient to hold all entries, the function returns ERROR_MORE_DATA. For more information, see Network Management Function Buffers and Network Management Function Buffer Lengths.

entriesread

[out] Pointer to a DWORD value that receives the count of elements actually enumerated.

totalentries

[out] Pointer to a DWORD value that receives the total number of entries that could have been enumerated from the current resume position.

resume_handle

[in/out] Pointer to a variable that contains a resume handle that is used to continue the global group enumeration. The handle should be zero on the first call and left unchanged for subsequent calls. If resume_handle is NULL, no resume handle is stored.

Return Values

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value can be 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. Specify a large enough buffer to receive all entries.

Remarks

If you are programming for Active Directory, you may be able to call certain Active Directory Service Interface (ADSI) methods to achieve the same functionality you can achieve by calling the network management group functions. For more information, see IADsGroup.

Requirements