Edit

MprAdminInterfaceGetCredentialsEx function (mprapi.h)

  • Article

Use the MprAdminInterfaceGetCredentialsEx function to retrieve extended credentials information for the specified interface. Use this function to retrieve credentials information used for Extensible Authentication Protocols (EAPs).

Syntax

DWORD MprAdminInterfaceGetCredentialsEx(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  HANDLE            hInterface,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer
);

Parameters

[in] hMprServer

Handle to a router. This handle is obtained from a previous call to MprAdminServerConnect.

[in] hInterface

Handle to the interface. This handle is obtained from a previous call to MprAdminInterfaceCreate.

[in] dwLevel

A DWORD value that describes the format in which the information is returned in the lplpbBuffer parameter. Acceptable values for dwLevel include 0 or 1, as listed in the following table.

Value Structure Format
0 Windows 2000 Server: MPR_CREDENTIALSEX_0
1 Windows Server 2003 or later: MPR_CREDENTIALSEX_1
 

A value of 1 indicates the information is a pre-shared key for the interface, which is in an encrypted format.

[out] lplpbBuffer

On successful completion, a pointer to a MPR_CREDENTIALSEX_0 or MPR_CREDENTIALSEX_1 structure. The dwLevel parameter indicates the type of structure. Free the memory occupied by this structure with MprAdminBufferFree.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_ACCESS_DENIED
 The calling application does not have sufficient privileges.
ERROR_INVALID_HANDLE
 The hInterface value is invalid.
ERROR_INVALID_PARAMETER
 The lplpbBuffer parameter is NULL.
ERROR_NOT_ENOUGH_MEMORY
 Insufficient resources to complete the operation.
ERROR_NOT_SUPPORTED
 The dwLevel value is invalid.

Requirements

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

See also

MPR_CREDENTIALSEX_0

MPR_CREDENTIALSEX_1

MprAdminInterfaceCreate

MprAdminInterfaceGetCredentials

MprAdminInterfaceSetCredentialsEx

MprAdminServerConnect