MprAdminConnectionGetInfoEx function (mprapi.h)

Article
02/22/2024

The MprAdminConnectionGetInfoEx function retrieves the connection information for a specific connection on a specified RRAS server.

Syntax

DWORD MprAdminConnectionGetInfoEx(
  [in]  RAS_SERVER_HANDLE  hRasServer,
  [in]  HANDLE             hRasConnection,
  [out] PRAS_CONNECTION_EX pRasConnection
);

Parameters

[in] hRasServer

A handle to the computer from which the connection information is retrieved. To obtain this handle, call MprAdminServerConnect.

[in] hRasConnection

A handle to the connection to retrieve data about. To obtain this handle, call MprAdminConnectionEnum.

[out] pRasConnection

A pointer, on output, to a RAS_CONNECTION_EX structure that contains the connection information for the RRAS server in hRasServer.

To free this memory, call 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_DDM_NOT_RUNNING	The Demand Dial Manager (DDM) is not running.
ERROR_PROC_NOT_FOUND	The specified procedure could not be found.
Other	An error from MprError.h, RasError.h, or WinError.h.

Remarks

The caller should free the memory pointed to by pRasConnection by calling the function MprAdminBufferFree.

Requirements

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