MprConfigServerGetInfo

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
[in] Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
dwLevel
[in] Specifies the level of the information requested. This parameter must be zero.
lplpBuffer
[out] Pointer to a pointer variable. This variable points to a buffer that receives the retrieved information. Free the memory for this buffer using MprConfigBufferFree.

Return Values

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.

Remarks

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Configuration Functions, FormatMessage, MPR_SERVER_0, MprConfigBufferFree, MprConfigServerConnect