Edit

Share via

MprConfigServerGetInfo function (mprapi.h)

  • Article

The MprConfigServerGetInfo function retrieves server-level configuration information for the specified router.

Syntax

DWORD MprConfigServerGetInfo(
  [in]  HANDLE hMprConfig,
  [in]  DWORD  dwLevel,
  [out] LPBYTE *lplpbBuffer
);

Parameters

[in] hMprConfig

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

[in] dwLevel

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

Value Structure Format
0 Windows 2000 Server or later: MPR_SERVER_0
1 Windows Server 2003 or later: MPR_SERVER_1
2 Windows Server 2008 or later: MPR_SERVER_2

[out] lplpbBuffer

On successful completion, a pointer to a MPR_SERVER_0, MPR_SERVER_1,
or MPR_SERVER_2 structure. The dwLevel parameter indicates the type of structure. Free the memory for this buffer using MprConfigBufferFree.

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_INVALID_PARAMETER
 At least one of the following is true:
  • The hMprConfig parameter is NULL.
  • The dwLevel parameter is not zero.
  • The lplpBuffer parameter is NULL.
ERROR_NOT_ENOUGH_MEMORY
 Insufficient resources to complete the operation.
Other
 Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

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

FormatMessage

MPR_SERVER_0

MPR_SERVER_1

MPR_SERVER_2

MprConfigBufferFree

MprConfigServerConnect

MprConfigServerSetInfo

Router Configuration Functions

Router Management Reference