Platform SDK: Network Management

NetUserGetInfo

The NetUserGetInfo function retrieves information about a particular user account on a server.

Security Requirements

Windows NT: No special group membership is required to successfully execute the NetUserGetInfo function. This is a change from LAN Manager, which required membership in the Administrators or Account Operators local group to call this function at information levels above 0 (except for the user's own account, which could use level 11).

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 all authenticated users and members of the "Pre-Windows 2000 compatible access" group to view the information. By default, the "Pre-Windows 2000 compatible access" group includes Everyone as a member. This enables anonymous access to the information if the system allows anonymous access.

If you call this function on a Windows 2000 member server or workstation, all authenticated users can view the information. Anonymous access is also permitted if the RestrictAnonymous policy setting allows anonymous access.

For more information about restricting anonymous access, see Security Requirements for the Network Management Functions.

NET_API_STATUS NetUserGetInfo(
  LPCWSTR servername,  
  LPCWSTR username,    
  DWORD level,        
  LPBYTE *bufptr      
);

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 containing the name of the user account for which to return information.
level
[in] Specifies the information level of the data. This parameter can be one of the following values.
Value Meaning
0 Return the user account name. The bufptr parameter points to a USER_INFO_0 structure.
1 Return detailed information about the user account. The bufptr parameter points to a USER_INFO_1 structure.
2 Return level one information and additional attributes about the user account. The bufptr parameter points to a USER_INFO_2 structure.
3 Return level two information and additional attributes about the user account. This level is valid only on Windows NT/Windows 2000 servers. The bufptr parameter points to a USER_INFO_3 structure.
10 Return user and account names and comments. The bufptr parameter points to a USER_INFO_10 structure.
11 Return detailed information about the user account. The bufptr parameter points to a USER_INFO_11 structure.
20 Return the user's name and identifier and various account attributes. The bufptr parameter points to a USER_INFO_20 structure.

bufptr
[out] Pointer to the buffer that receives the data. The format of this data depends on the value of the level parameter. This buffer is allocated by the system and must be freed using the NetApiBufferFree function.

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_UserNotFound The user name could not be found.

Remarks

The following code sample demonstrates how to retrieve information about a particular user account with a call to the NetUserGetInfo function. The sample calls NetUserGetInfo, specifying information level 10 (USER_INFO_10). If the call succeeds, the code prints information about the user account. Finally, the sample frees the memory allocated for the information buffer.

#ifndef UNICODE
#define UNICODE
#endif

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

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 10;
   LPUSER_INFO_10 pBuf = NULL;
   NET_API_STATUS nStatus;

   if (argc != 3)
   {
      fwprintf(stderr, L"Usage: %s \\\\ServerName UserName\n", argv[0]);
      exit(1);
   }
   //
   // Call the NetUserGetInfo function; specify level 10.
   //
   nStatus = NetUserGetInfo(argv[1],
                            argv[2],
                            dwLevel,
                            (LPBYTE *)&pBuf);
   //
   // If the call succeeds, print the user information.
   //
   if (nStatus == NERR_Success)
   {
    if (pBuf != NULL)
      {
         wprintf(L"\n\tAccount:      %s\n", pBuf->usri10_name);
         wprintf(L"\tComment:      %s\n", pBuf->usri10_comment);
         wprintf(L"\tUser comment: %s\n", pBuf->usri10_usr_comment);
         wprintf(L"\tFull name:    %s\n", pBuf->usri10_full_name);
      }
   }
   // Otherwise, print the system error.
   //
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   //
   // Free the allocated memory.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);

   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

  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, User Functions, NetUserSetInfo, NetUserGetGroups, NetUserEnum, USER_INFO_0, USER_INFO_1, USER_INFO_2, USER_INFO_3, USER_INFO_10, USER_INFO_11, USER_INFO_20