Platform SDK: Network Management

NetLocalGroupDelMembers

The NetLocalGroupDelMembers function removes one or more members from an existing local group. Local group members can be users or global groups.

Security Requirements

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

Parameters

servername
[in] Pointer to a constant null-terminated 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 null-terminated Unicode string specifying the name of the local group from which the specified users or global groups will be removed.
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) of a local group member to remove. The buf parameter points to an array of LOCALGROUP_MEMBERS_INFO_0 structures.
3 Specifies the domain and name of a local group member to remove. The buf parameter points to an array of LOCALGROUP_MEMBERS_INFO_3 structures.

buf
[in] Pointer to a buffer specifying the members to be removed. The format of this data depends on the value of the level parameter.
totalentries
[in] Specifies the number of entries in the array 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 local group specified by the groupname parameter does not exist.
ERROR_NO_SUCH_MEMBER One or more of the specified members do not exist. No members were deleted.
ERROR_MEMBER_IN_ALIAS One or more of the members specified were not members of the local group. No members were deleted.

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 local 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, Local Group Functions, LOCALGROUP_MEMBERS_INFO_0, LOCALGROUP_MEMBERS_INFO_3, NetLocalGroupAddMembers, NetLocalGroupDel, NetLocalGroupGetMembers