Platform SDK: Network Management

NetGroupGetInfo

The NetGroupGetInfo function retrieves information about a particular global group in the security database.

Security Requirements

Windows NT: Only members of the Administrators or Account Operators local group can successfully execute the NetGroupGetInfo 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 NetGroupGetInfo(
  LPCWSTR servername, 
  LPCWSTR groupname,  
  DWORD level,        
  LPBYTE *bufptr      
);

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.
groupname
[in] Pointer to a constant null-terminated Unicode character string specifying the name of the global group for which to retrieve information.
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 a GROUP_INFO_0 structure.
1 Return the global group name and a comment. The bufptr parameter points to a GROUP_INFO_1 structure.
2 Return detailed information about the global group. The bufptr parameter points to a GROUP_INFO_2 structure.

bufptr
[out] Pointer to the address of the buffer that receives 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.

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.
NERR_GroupNotFound The global group name could not be found.

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

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Unsupported.
  Header: Declared in Lmaccess.h; include Lm.h.
  Library: Use Netapi32.lib.

See Also

Network Management Overview, Network Management Functions, Group Functions, GROUP_INFO_0, GROUP_INFO_1, GROUP_INFO_2, NetGroupSetInfo, NetApiBufferFree