Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The MprAdminServerGetInfo function retrieves information about the specified RRAS server.
Syntax
DWORD MprAdminServerGetInfo(
[in] MPR_SERVER_HANDLE hMprServer,
[in] DWORD dwLevel,
[out] LPBYTE *lplpbBuffer
);
Parameters
[in] hMprServer
Handle to the router to query. Obtain this handle by calling MprAdminServerConnect.
[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
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 |
|---|---|
|
The calling application does not have sufficient privileges. |
|
The lplpbBuffer parameter is NULL. |
|
The hMprServer parameter is NULL. |
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 |