Skip to content

Latest commit

 

History

History
187 lines (139 loc) · 4.66 KB

nf-mprapi-mprconfigservergetinfo.md

File metadata and controls

187 lines (139 loc) · 4.66 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mprapi.MprConfigServerGetInfo
MprConfigServerGetInfo function (mprapi.h)
The MprConfigServerGetInfo function retrieves server-level configuration information for the specified router.
MprConfigServerGetInfo
MprConfigServerGetInfo function [RAS]
_mpr_mprconfigservergetinfo
mprapi/MprConfigServerGetInfo
rras.mprconfigservergetinfo
rras\mprconfigservergetinfo.htm
RRAS
6d3cd97a-96ef-4ecd-b2fd-2743ba79aa5b
12/05/2018
MprConfigServerGetInfo, MprConfigServerGetInfo function [RAS], _mpr_mprconfigservergetinfo, mprapi/MprConfigServerGetInfo, rras.mprconfigservergetinfo
mprapi.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Mprapi.lib
Mprapi.dll
Windows
19H1
MprConfigServerGetInfo
mprapi/MprConfigServerGetInfo
c++
APIRef
kbSyntax
DllExport
Mprapi.dll
MprConfigServerGetInfo

MprConfigServerGetInfo function

-description

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

-parameters

-param hMprConfig [in]

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

-param dwLevel [in]

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

-param lplpbBuffer [out]

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.

-returns

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.

-see-also

FormatMessage

MPR_SERVER_0

MPR_SERVER_1

MPR_SERVER_2

MprConfigBufferFree

MprConfigServerConnect

MprConfigServerSetInfo

Router Configuration Functions

Router Management Reference