Skip to content

Latest commit

 

History

History
299 lines (222 loc) · 9.81 KB

ns-mprapi-ras_connection_4.md

File metadata and controls

299 lines (222 loc) · 9.81 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:mprapi._RAS_CONNECTION_4
RAS_CONNECTION_4 (mprapi.h)
Contains specific information for the connection that includes:\_the user name, domain, Globally Unique Identifier (GUID) associated with the connection, Network Access Protection (NAP) quarantine state, packet statistics, as well as its Point-to-Point (PPP) and Internet Key Exchange version 2 (IKEv2) related information.
*PRAS_CONNECTION_4
PRAS_CONNECTION_4
PRAS_CONNECTION_4 structure pointer [RAS]
RAS_CONNECTION_4
RAS_CONNECTION_4 structure [RAS]
RAS_FLAGS_ARAP_CONNECTION
RAS_FLAGS_DORMANT
RAS_FLAGS_IKEV2_CONNECTION
RAS_FLAGS_MESSENGER_PRESENT
RAS_FLAGS_PPP_CONNECTION
RAS_FLAGS_QUARANTINE_PRESENT
RDT_Tunnel_IKev2
RDT_Tunnel_L2tp
RDT_Tunnel_Pptp
RDT_Tunnel_Sstp
mprapi/PRAS_CONNECTION_4
mprapi/RAS_CONNECTION_4
rras.ras_connection_4
rras\ras_connection_4.htm
RRAS
b7cd637d-45ad-4e4c-b5b2-e85b142375ff
12/05/2018
*PRAS_CONNECTION_4, PRAS_CONNECTION_4, PRAS_CONNECTION_4 structure pointer [RAS], RAS_CONNECTION_4, RAS_CONNECTION_4 structure [RAS], RAS_FLAGS_ARAP_CONNECTION, RAS_FLAGS_DORMANT, RAS_FLAGS_IKEV2_CONNECTION, RAS_FLAGS_MESSENGER_PRESENT, RAS_FLAGS_PPP_CONNECTION, RAS_FLAGS_QUARANTINE_PRESENT, RDT_Tunnel_IKev2, RDT_Tunnel_L2tp, RDT_Tunnel_Pptp, RDT_Tunnel_Sstp, mprapi/PRAS_CONNECTION_4, mprapi/RAS_CONNECTION_4, rras.ras_connection_4
mprapi.h
Windows
None supported
Windows Server 2012 [desktop apps only]
Windows
RAS_CONNECTION_4, *PRAS_CONNECTION_4
19H1
_RAS_CONNECTION_4
mprapi/_RAS_CONNECTION_4
PRAS_CONNECTION_4
mprapi/PRAS_CONNECTION_4
RAS_CONNECTION_4
mprapi/RAS_CONNECTION_4
c++
APIRef
kbSyntax
HeaderDef
mprapi.h
RAS_CONNECTION_4

RAS_CONNECTION_4 structure

-description

Contains specific information for the connection that includes: the user name, domain, Globally Unique Identifier (GUID) associated with the connection, Network Access Protection (NAP) quarantine state, packet statistics, as well as its Point-to-Point (PPP) and Internet Key Exchange version 2 (IKEv2) related information.

-struct-fields

-field dwConnectDuration

A value that represent the duration of the connection in seconds.

-field dwInterfaceType

A ROUTER_INTERFACE_TYPE enumeration that identifies the type of connection interface.

-field dwConnectionFlags

A bitmap of flags that specify connection attributes. The dwConnectionFlags member must contain at least one of the following values.

Value Meaning
RAS_FLAGS_PPP_CONNECTION
0x00000001
The connection is using Point-to-Point Protocol (PPP).
RAS_FLAGS_MESSENGER_PRESENT
0x00000002
The messenger service is active on the client and messages can be sent to the client using the MprAdminSendUserMessage function.
RAS_FLAGS_QUARANTINE_PRESENT
0x00000008
The connection is currently in quarantine. For information on how to remove the connection from quarantine, please see MprAdminConnectionRemoveQuarantine.
RAS_FLAGS_ARAP_CONNECTION
0x00000010
The connection is using AppleTalk Remote Access Protocol (ARAP).
RAS_FLAGS_IKEV2_CONNECTION
0x00000010
The connection is using IKEv2.
RAS_FLAGS_DORMANT
0x00000020
The connection is using IKEv2 and the server is not reachable.

-field wszInterfaceName

A null-terminated Unicode string that contains the name of the interface for this connection.

-field wszUserName

A null-terminated Unicode string that contains the name of the user logged on to the connection.

-field wszLogonDomain

A null-terminated Unicode string that contains the domain on which the connected user is authenticated.

-field wszRemoteComputer

A null-terminated Unicode string that contains the name of the remote computer.

-field guid

A GUID that identifies the connection. For incoming connections, this GUID is valid only as long as the connection is active.

-field rasQuarState

A RAS_QUARANTINE_STATE structure that specifies the NAP quarantine state of the connection.

-field probationTime

A FILETIME structure that specifies the time required for the connection to come out of quarantine after which the connection will be dropped. This value is valid only if the rasQuarState member has a value of RAS_QUAR_STATE_PROBATION.

-field connectionStartTime

A FILETIME structure that specifies the connection start time in UTC.

-field ullBytesXmited

A value that specifies the number of bytes transmitted on the connection.

-field ullBytesRcved

A value that specifies the number of bytes received on the connection.

-field dwFramesXmited

A value that specifies the number of frames transmitted on the connection.

-field dwFramesRcved

A value that specifies the number of frames received on the connection.

-field dwCrcErr

A value that specifies the number of Cyclic Redundancy Check (CRC) errors on the connection.

-field dwTimeoutErr

A value that specifies the number of time-out errors on the connection.

-field dwAlignmentErr

A value that specifies the number of alignment errors on the connection.

-field dwHardwareOverrunErr

A value that specifies the number of hardware overrun errors on the connection.

-field dwFramingErr

A value that specifies the number of framing errors on the connection.

-field dwBufferOverrunErr

A value that specifies the number of buffer overrun errors on the connection.

-field dwCompressionRatioIn

A value that specifies the percentage by which data received on this connection is compressed. The dwCompressionRatioIn member is the size of the compressed data divided by the size of the same data in an uncompressed state.

-field dwCompressionRatioOut

A value that specifies the percentage by which data transmitted on this connection is compressed. The ratio is the size of the compressed data divided by the size of the same data in an uncompressed state.

-field dwNumSwitchOvers

A value that specifies the number of IKEv2 Mobility and Multihoming Protocol (MOBIKE) switches that have occurred on the connection. The dwNumSwitchOvers member is only valid if the dwConnectionFlags member is RAS_FLAGS_IKEV2_CONNECTION.

-field wszRemoteEndpointAddress

A null-terminated Unicode string that contains the IP address of the remote computer in the connection. This string is of the form "a.b.c.d".

-field wszLocalEndpointAddress

A null-terminated Unicode string that contains the IP address of the local computer in the connection. This string is of the form "a.b.c.d".

-field ProjectionInfo

A PROJECTION_INFO2 structure that contains either a PPP_PROJECTION_INFO2 structure or a IKEV2_PROJECTION_INFO2 structure.

-field hConnection

A handle to the RAS connection.

-field hInterface

A handle to the RAS connection interface.

-field dwDeviceType

A value that specifies the tunnel type of the VPN connection. The following table shows the possible values for this member.

Value Meaning
RDT_Tunnel_Pptp
Point-to-Point tunnel (PPTP)
RDT_Tunnel_L2tp
L2TP tunnel
RDT_Tunnel_Sstp
SSTP tunnel
RDT_Tunnel_IKev2
IKEv2 tunnel