MprAdminInterfaceGetInfo function (mprapi.h)
The MprAdminInterfaceGetInfo function retrieves information for a specified interface on a specified server.
Syntax
DWORD MprAdminInterfaceGetInfo(
[in] MPR_SERVER_HANDLE hMprServer,
[in] HANDLE hInterface,
[in] DWORD dwLevel,
[in] LPBYTE *lplpbBuffer
);
Parameters
[in] hMprServer
Handle to the router to query. This handle is obtained from a previous call to MprAdminServerConnect.
[in] hInterface
Handle to the interface obtained by a previous call to MprAdminInterfaceCreate.
[in] dwLevel
A DWORD value that describes the format in which the information is structured in the lplpbBuffer parameter. Acceptable values for dwLevel include 0, 1, 2, and 3, as listed in the following table.
| Value | Structure Format |
|---|---|
| 0 | MPR_INTERFACE_0 |
| 1 | MPR_INTERFACE_1 |
| 2 | MPR_INTERFACE_2 |
| 3 | Windows Server 2008 or later: MPR_INTERFACE_3 |
Values of 1, 2, and 3 are valid only for interfaces of type ROUTER_CONNECTION_STATE.
[in] lplpbBuffer
A pointer to a
MPR_INTERFACE_0,
MPR_INTERFACE_1,
MPR_INTERFACE_2, or MPR_INTERFACE_3 structure. The dwLevel parameter indicates the type of structure.
Free this memory by calling
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 dwLevel is 2, but that level is not supported for the interface. For example, the type of interface, as defined in the MPR_INTERFACE_X structure, is not IF_TYPE_FULL_ROUTER. |
|
The hInterface value is invalid. |
|
The lplpbBuffer parameter is NULL. |
|
Insufficient resources to complete the operation. |
|
The dwLevel value is invalid. |
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 |