GetInterfaceConfigInfo

[This is preliminary documentation and subject to change.]

The GetInterfaceConfigInfo function gets the configuration information kept by the routing protocol for a specific interface.

DWORD GetInterfaceConfigInfo(
  ULONG InterfaceIndex,     // the index of the interface
  PVOID InterfaceInfo,      // buffer for interface information
  PULONG InterfaceInfoSize  // size of the buffer for interface 
                            // information
);
 

Parameters

InterfaceIndex

Identifies the interface in the set of interfaces configured on the router.

InterfaceInfo

Pointer to a buffer that receives the protocol-defined configuration information associated with the interface. This information is private to the routing protocol.

InterfaceInfoSize

Pointer to a DWORD variable.

On input: This variable contains the size, in bytes, of the buffer provided to receive the configuration information.

On output: This variable contains the size, in bytes, of the data placed in the buffer. If the initial size was not large enough, this variable contains the size required to hold all of the data.

Return Values

NO_ERROR

The information was retrieved successfully. The buffer pointed to by the InterfaceInfo parameter contains the configuration information.

ERROR_CAN_NOT_COMPLETE

The attempt to retrieve the information failed.

ERROR_INVALID_PARAMETER

The InterfaceIndex parameter is invalid (for example, no interface exists with that index), or the InterfaceInfoSize parameter is NULL.

ERROR_INSUFFICIENT_BUFFER

The size of the output buffer provided is not large enough to hold the requested information. The required size is returned in the DWORD variable pointed to by InterfaceInfoSize.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in routprot.h.
  Import Library: user-defined.

See Also

GetInterfaceConfigInfo Sample, SetInterfaceConfigInfo