MprConfigServerGetInfo

[This is preliminary documentation and subject to change.]

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

DWORD  MprConfigServerGetInfo (
    HANDLE      hMprConfig,    // handle to the router configuration
    DWORD       dwLevel,       // level of information
    LPBYTE  *   lplpBuffer     // buffer to receive information
)

Parameters

hMprConfig

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

dwLevel

Specifies the level of the information requested. This parameter must be zero.

lplpBuffer

Pointer to a pointer variable. On successful return, this variable will point to a buffer containing the retrieved information. Free the memory for this buffer using MprConfigBufferFree.

Return Values

NO_ERROR

The information was retrieved successfully.

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 corresponding to the error code returned.

Remarks

Currently, the only information returned by MprConfigServerGetInfo is the fLanOnlyMode flag.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

FormatMessage, MPR_SERVER_0, MprConfigBufferFree, MprConfigServerConnect