MPR_INTERFACE_1 structure (mprapi.h)

The MPR_INTERFACE_1 structure contains configuration and status information for a particular router interface.

Syntax

typedef struct _MPR_INTERFACE_1 {
  WCHAR                   wszInterfaceName[MAX_INTERFACE_NAME_LEN + 1];
  HANDLE                  hInterface;
  BOOL                    fEnabled;
  ROUTER_INTERFACE_TYPE   dwIfType;
  ROUTER_CONNECTION_STATE dwConnectionState;
  DWORD                   fUnReachabilityReasons;
  DWORD                   dwLastError;
  LPWSTR                  lpwsDialoutHoursRestriction;
} MPR_INTERFACE_1, *PMPR_INTERFACE_1;

Members

wszInterfaceName[MAX_INTERFACE_NAME_LEN + 1]

Pointer to a Unicode string that contains the name of the interface.

hInterface

Handle to the interface.

fEnabled

Specifies whether the interface is enabled. This value is TRUE if the interface is enabled, FALSE if the interface is administratively disabled.

dwIfType

Specifies the type of interface.

dwConnectionState

Specifies the current state of the interface, for example connected, disconnected, or unreachable. For a list of possible states, see ROUTER_CONNECTION_STATE.

fUnReachabilityReasons

Specifies a value that represents a reason why the interface was unreachable. See Unreachability Reasons for a list of possible values.

dwLastError

Specifies a nonzero value if the interface fails to connect.

lpwsDialoutHoursRestriction

Pointer to a Unicode string that specifies the times during which dial-out is restricted. The format for this string is:

<day><space><time range><space><time range> . . . <NULL><day>. . . <NULL><NULL>

Where day is a numeral that corresponds to a day of the week.

Time range is of the form HH:MM-HH:MM, using 24-hour notation.

The string <space> in the preceding syntax denotes a space character. The string <NULL> denotes a null character.

The restriction string is terminated by two consecutive null characters.

Example:

2 09:00-12:00 13:00-17:30<NULL>4 09:00-12:00 13:00-17:30<NULL><NULL>

The preceding string restricts dial-out to Tuesdays and Thursdays from 9:00 AM to 12:00 PM and from 1:00 PM to 5:30 PM.

Requirements

See also

MprAdminInterfaceCreate

MprAdminInterfaceEnum

MprAdminInterfaceGetInfo

ROUTER_CONNECTION_STATE

ROUTER_INTERFACE_TYPE

Router Management Reference

Router Management Structures

Unreachability Reasons