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 MprConfigInterfaceGetInfo function retrieves the configuration for the specified interface from the router.
Syntax
DWORD MprConfigInterfaceGetInfo(
[in] HANDLE hMprConfig,
[in] HANDLE hRouterInterface,
[in] DWORD dwLevel,
[in, out] LPBYTE *lplpBuffer,
[out] LPDWORD lpdwBufferSize
);
Parameters
[in] hMprConfig
Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
[in] hRouterInterface
Handle to the interface configuration for which to retrieve information. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.
[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, 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 |
[in, out] lplpBuffer
On input, a non-NULL pointer.
On successful completion, a pointer to an array of
MPR_INTERFACE_0,
MPR_INTERFACE_1,
MPR_INTERFACE_2, or MPR_INTERFACE_3 structure. The dwLevel parameter indicates the type of structure.
Free this buffer by calling
MprConfigBufferFree.
[out] lpdwBufferSize
Pointer to a DWORD variable. This variable receives the size, in bytes, of the data returned through lplpBuffer.
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 |
|---|---|
|
At least one of the following is true:
|
|
Insufficient resources to complete the operation. |
|
The interface that corresponds to hRouterInterface is not present in the router configuration. |
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 |