MprAdminUserGetInfo function (mprapi.h)

Article
10/13/2021

The MprAdminUserGetInfo function retrieves all RAS information for a particular user.

Syntax

DWORD MprAdminUserGetInfo(
  [in]  LPCWSTR lpszServer,
  [in]  LPCWSTR lpszUser,
  [in]  DWORD   dwLevel,
  [out] LPBYTE  lpbBuffer
);

Parameters

[in] lpszServer

Pointer to a Unicode string that specifies the name of the server with the master User Accounts Subsystem (UAS). If the remote access server is part of a domain, the computer with the UAS is either the primary domain controller or the backup domain controller. If the remote access server is not part of a domain, then the server itself stores the UAS. In either case, call the MprAdminGetPDCServer function to obtain the value for this parameter.

If the server itself stores the UAS, this parameter can be NULL.

[in] lpszUser

Pointer to a Unicode string that specifies the name of the user for which to get RAS information.

[in] dwLevel

This parameter may be zero or one.

Windows NT Server 4.0 with SP3 and later: This parameter must be zero.

[out] lpbBuffer

Pointer to a RAS_USER_0 or RAS_USER_1 structure. The caller must allocate (and free) the memory for this structure. Upon successful return, this structure contains the RAS data for the specified user.

Windows NT Server 4.0 with SP3 and later: If the dwLevel parameter specifies zero, lpbBuffer should point to a RAS_USER_0 structure.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails the return value is one of the following values.

Value	Meaning
ERROR_ACCESS_DENIED	The caller does not have sufficient privileges.
ERROR_INVALID_LEVEL	The value of dwLevel is invalid.
ERROR_INVALID_PARAMETER	lpbBuffer is NULL
ERROR_NO_SUCH_USER	The user specified by lpwsUserName does not exist on the server specified by lpwsServerName.

Remarks

This function is available on Windows NT 4.0 if the RRAS redistributable is installed. However, the version of Mprapi.dll that ships with the RRAS redistributable exports the function as RasAdminUserGetInfo rather than MprAdminUserGetInfo. Therefore, when using the RRAS redistributable, use LoadLibrary and GetProcAddress to access this function.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	mprapi.h
Library	Mprapi.lib
DLL	Mprapi.dll