MprConfigInterfaceGetInfo

[This is preliminary documentation and subject to change.]

The MprConfigInterfaceGetInfo function retrieves the configuration for the specified interface from the router.

DWORD  MprConfigInterfaceGetInfo(
  HANDLE hMprConfig,          // handle to the router configuration
  HANDLE hRouterInterface,    // handle to the interface configuration
  DWORD dwLevel,              // level of information requested
  LPBYTE * lplpBuffer,        // MPR_INTERFACE_0 structure
  LPDWORD lpdwBufferSize      // size of returned data
);

Parameters

hMprConfig

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

hRouterInterface

Handle to the interface configuration for which to retrieve information. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.

dwLevel

Level of the information returned in the lplpBuffer parameter. This parameter must be zero.

lplpBuffer

Pointer to a pointer variable. On successful return, this pointer variable points to an MPR_INTERFACE_0 structure. Free this buffer by calling MprConfigBufferFree.

lpdwBufferSize

Pointer to a DWORD variable. On successful return, this variable will contain the size, in bytes, of the data returned through lplpBuffer.

Return Values

NO_ERROR

The interface information was retrieved successfully.

ERROR_INVALID_PARAMETER

At least one of the following is true:

hMprConfig is NULL

hRouterInterface is NULL

dwLevel is not zero.

lplpBuffer is NULL

lpdwBufferSize is NULL

ERROR_NOT_ENOUGH_MEMORY

Insufficient resources to complete the operation.

ERROR_NO_SUCH_INTERFACE

The interface corresponding to hRouterInterface is not present in the router configuration.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

MprConfigBufferFree, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigServerConnect