NetGroupSetUsers

The NetGroupSetUsers function sets the global group membership for the specified global group. Each user specified is made a member of the global group. Users that are not specified but are currently members of the global group will have their membership revoked.

One use of NetGroupSetUsers is to replace the current membership with an entirely new membership. The typical sequence is to use the NetGroupGetUsers function, modify the returned membership list to look the way you want it to be, then call NetGroupSetUsers.

Security Requirements

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

NET_API_STATUS NetGroupSetUsers(
  LPWSTR servername,    
  LPWSTR groupname,     
  DWORD level,          
  LPBYTE buf,           
  DWORD NewMemberCount  
);
 

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.
groupname
Pointer to a Unicode string containing the name of the global group to which the specified users belong.
level
Specifies one of the following values to set the level of information pointed to in the buf parameter.
Value Meaning
0 Specify group name. The specified buffer points to an array of GROUP_USERS_INFO_0 structures.
1 Specify group attributes. The specified buffer points to an array of GROUP_USERS_INFO_1 structures.

buf
Pointer to the buffer location of the designated data.
NewMemberCount
Specifies the number of entries in the buffer pointed to by buf.

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.
NERR_NotPrimary The operation is allowed only on the primary domain controller of the domain.
NERR_GroupNotFound The group name could not be found.
NERR_UserNotFound The user name could not be found.
NERR_SpeGroupOp The operation is not allowed on specified special groups, which are user groups, admin groups, local groups, or guest groups.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in lmaccess.h.
  Import Library: Use netapi32.lib.

See Also

Networking (Net) Overview, Net Functions, NetGroupAddUser, NetGroupDel, NetGroupDelUser