Platform SDK: Network Management

NetGroupSetUsers

The NetGroupSetUsers function sets the membership for the specified global group. Each user you specify is enrolled as a member of the global group. Users you do not specify, but who are currently members of the global group, will have their membership revoked.

Security Requirements

Windows NT: Only members of the Administrators or Account Operators local group can successfully execute the NetGroupSetUsers function on a remote server.

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 only Administrators and account operators to call this function. On a member server or workstation, only Administrators and account operators can call this function. For more information, see Security Requirements for the Network Management Functions.

NET_API_STATUS NetGroupSetUsers(
  LPCWSTR servername, 
  LPCWSTR groupname,  
  DWORD level,        
  LPBYTE buf,         
  DWORD totalentries  
);

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 of interest.

level

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

Value	Meaning
0	The buf parameter points to an array of GROUP_USERS_INFO_0 structures that specify user names.

buf

[in] Pointer to the buffer that contains the data.

totalentries

[in] Specifies the number of entries in the buffer pointed to by the buf parameter.

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_NotPrimary	The operation is allowed only on the primary domain controller of the domain.
NERR_GroupNotFound	The global group name could not be found.
NERR_UserNotFound	The user name could not be found.
NERR_SpeGroupOp	The operation is not allowed on certain special groups. These groups include user groups, admin groups, local groups, and guest groups.

Remarks

You can replace the global group membership with an entirely new list of members by calling the NetGroupSetUsers function. The typical sequence of steps to perform this follows.

To replace the global group membership

Call the NetGroupGetUsers function to retrieve the current membership list.
Modify the returned membership list to reflect the new membership.
Call the NetGroupSetUsers function to replace the old membership list with the new membership list.

To grant one user membership in an existing global group, you can call the NetGroupAddUser function. To remove a user from a global group, call the NetGroupDelUser function.

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