Platform SDK: Network Management

NetLocalGroupSetMembers

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

Security Requirements

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

Parameters

servername

[in] Pointer to a constant Unicode 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 Unicode string specifying the name of the local group in which the specified users or global groups should be granted membership.

level

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

Value	Meaning
0	Specifies the security identifier (SID) associated with a local group member. The buf parameter points to an array of LOCALGROUP_MEMBERS_INFO_0 structures.
3	Specifies the account and domain names of the local group member. The buf parameter points to an array of LOCALGROUP_MEMBERS_INFO_3 structures.

buf

[in] Pointer to the buffer containing the member information. The format of this data depends on the value of the level parameter.

totalentries

[in] Specifies a DWORD value that contains the total 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
NERR_GroupNotFound	The group specified by the groupname parameter does not exist.
ERROR_NO_SUCH_MEMBER	One or more of the members doesn't exist. The local group membership was not changed.
ERROR_INVALID_MEMBER	One or more of the members cannot be added because it has an invalid account type. The local group membership was not changed.

Remarks

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

To replace the local group membership

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

To add one or more existing user accounts or global group accounts to an existing local group, you can call the NetLocalGroupAddMembers function. To remove one or more members from an existing local group, call the NetLocalGroupDelMembers 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 local group functions. For more information, see IADsGroup.

Requirements