Platform SDK: Network Management

NetUserSetGroups

The NetUserSetGroups function sets global group memberships for a specified user account.

Security Requirements

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

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.

username

[in] Pointer to a constant Unicode string specifying the name of the user for which to set global group memberships.

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 specifies global group names.

buf

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

num_entries

[in] Specifies the number of entries contained 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
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 specified by the grui0_name member does not exist.
NERR_UserNotFound	The user name could not be found.

Remarks

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

The following code sample demonstrates how to set global group memberships for a user account with a call to the NetUserSetGroups function. The code sample fills in the grui0_name member of the GROUP_USERS_INFO_0 structure and calls NetUserSetGroups, specifying information level 0.

#ifndef UNICODE
#define UNICODE
#endif

#include <stdio.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 0;
   GROUP_USERS_INFO_0 gi;
   NET_API_STATUS nStatus;

   if (argc != 4)
   {
      fwprintf(stderr, L"Usage: %s \\\\ServerName UserName GroupName\n", argv[0]);
      exit(1);
   }
   //
   // Fill in the GROUP_USERS_INFO_0 structure member.
   //
   gi.grui0_name = argv[3];
   //
   // Call the NetUserSetGroups function; specify level 0.
   //
   nStatus = NetUserSetGroups(argv[1],
                              argv[2],
                              dwLevel,
                              (LPBYTE)&gi,
                              1);
   //
   // If the call succeeds, inform the user.
   //
   if (nStatus == NERR_Success)
      fwprintf(stderr, L"Group membership has been successful for %s\n", argv[2]);
   //
   // Otherwise, print the system error.
   //
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);

   return 0;
}

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 user functions. For more information, see IADsUser and IADsComputer.

Requirements