Edit

PINTERFACE_STATUS callback function (routprot.h)

  • Article

Router manager calls the InterfaceStatus function to change the status of an interface.

The PINTERFACE_STATUS type defines a pointer to this callback function. InterfaceStatus is a placeholder for the application-defined function name.

Syntax

PINTERFACE_STATUS PinterfaceStatus;

DWORD PinterfaceStatus(
  [in] ULONG InterfaceIndex,
  [in] BOOL InterfaceActive,
  [in] DWORD StatusType,
  [in] PVOID StatusInfo
)
{...}

Parameters

[in] InterfaceIndex

Specifies the index of the interface to change.

[in] InterfaceActive

Specifies whether the interface is active.

[in] StatusType

Specifies the new interface status. This parameter is one of the following values.

RIS_INTERFACE_ADDRESS_CHANGE

RIS_INTERFACE_ENABLED

RIS_INTERFACE_DISABLED

RIS_INTERFACE_MEDIA_PRESENT

RIS_INTERFACE_MEDIA_ABSENT

[in] StatusInfo

Pointer to a structure that specifies information appropriate to the type of interface status type. For example, if the StatusType parameter specifies an address change, the StatusInfo parameter points to a structure that contains the new address information, such as IP_ADAPTER_BINDING_INFO. This parameter may be NULL.

Return value

If the function succeeds, the return value should be NO_ERROR.

If the function fails, the return value should be one of the following error codes.

Value Description
ERROR_CAN_NOT_COMPLETE
 Unspecified failure.
ERROR_INVALID_PARAMETER
 The InterfaceIndex parameter is invalid (for example, no interface exists with that index).
 
 

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header routprot.h

See also

AddInterface

DeleteInterface