MprConfigServerGetInfoEx function (mprapi.h)

The MprConfigServerGetInfoEx function retrieves port information for a specified server.

Syntax

DWORD MprConfigServerGetInfoEx(
  [in]  HANDLE        hMprConfig,
  [out] MPR_SERVER_EX *pServerInfo
);

Parameters

[in] hMprConfig

A handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

[out] pServerInfo

A pointer, on output, to a MPR_SERVER_EX structure that contains the port information for the RRAS server in hMprConfig.

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
Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Requirements

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

See also

MprAdminServerGetInfoEx

MprAdminServerSetInfoEx

MprConfigBufferFree

MprConfigServerConnect

Router Configuration Functions

Router Management Reference