MPR_INTERFACE_0

[This is preliminary documentation and subject to change.]

The MPR_INTERFACE_0 structure contains information for a particular router interface.

typedef struct _MPR_INTERFACE_0 {
    WCHAR                  wszInterfaceName[MAX_INTERFACE_NAME_LEN+1];
    HANDLE                     hInterface;
    BOOL                       fEnabled;
    ROUTER_INTERFACE_TYPE      IfType;
    ROUTER_CONNECTION_STATE    dwConnectionState;
    DWORD                      fUnReachabilityReasons;
    DWORD                      dwLastError;
} MPR_INTERFACE_0, * PMPR_INTERFACE_0;

Members

wszInterfaceName

Pointer to a unicode string containing the name of the interface.

hInterface

Handle to the interface

fEnabled

TRUE if the interface is enabled. FALSE if the interface is administratively disabled.

IfType

Type of the interface

dwConnectionState

The current state of the interface, for example connected, disconnected, unreachable. See ROUTER_CONNECTION_STATE for a list of possible states.

fUnReachabilityReasons;

If the interface is unreachable, this member stores the reason.

MPR_INTERFACE_OUT_OF_RESOURCES

No ports or devices are available for use.

MPR_INTERFACE_ADMIN_DISABLED

The administrator has disabled the interface.

MPR_INTERFACE_CONNECTION_FAILURE

The previous connection attempt failed. Look at the dwLastError field for the error code.

MPR_INTERFACE_SERVICE_PAUSED

The service is paused.

dwLastError

Set to non-zero value if the interface fails to connect.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: N/A.

See Also

MprAdminInterfaceEnum, MprAdminInterfaceGetInfo, ROUTER_CONNECTION_STATE, ROUTER_INTERFACE_TYPE