VpnPacketBuffer VpnPacketBuffer VpnPacketBuffer VpnPacketBuffer Class

Definition

Used by the platform to manage a memory buffer. VpnPacketBuffer allows buffers to be chained together in a IVpnPacketBufferList object list to be sent or received in a specific order.

public : sealed class VpnPacketBuffer : IVpnPacketBuffer, IVpnPacketBuffer2public sealed class VpnPacketBuffer : IVpnPacketBuffer, IVpnPacketBuffer2Public NotInheritable Class VpnPacketBuffer Implements IVpnPacketBuffer, IVpnPacketBuffer2// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Constructors

VpnPacketBuffer(VpnPacketBuffer, UInt32, UInt32) VpnPacketBuffer(VpnPacketBuffer, UInt32, UInt32) VpnPacketBuffer(VpnPacketBuffer, UInt32, UInt32) VpnPacketBuffer(VpnPacketBuffer, UInt32, UInt32)

Not used.

public : VpnPacketBuffer(VpnPacketBuffer parentBuffer, unsigned int offset, unsigned int length)public VpnPacketBuffer(VpnPacketBuffer parentBuffer, UInt32 offset, UInt32 length)Public Sub New(parentBuffer As VpnPacketBuffer, offset As UInt32, length As UInt32)// This API is not available in Javascript.
Parameters
parentBuffer
VpnPacketBuffer VpnPacketBuffer VpnPacketBuffer VpnPacketBuffer

A pointer to the parent buffer in the chain.

offset
unsigned int UInt32 UInt32 UInt32

Offset value.

length
unsigned int UInt32 UInt32 UInt32

The size of the buffer.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Properties

AppId AppId AppId AppId

Gets the app ID representing the app that caused this packet to flow. This is present only on the first packet of a flow. The presence of this property indicates it is the first packet.

public : VpnAppId AppId { get; }public VpnAppId AppId { get; }Public ReadOnly Property AppId As VpnAppId// This API is not available in Javascript.
Value
VpnAppId VpnAppId VpnAppId VpnAppId

The app ID representing the app that caused this packet to flow.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Buffer Buffer Buffer Buffer

Gets the memory buffer object, designed to contain packets of date to be sent or received as part of a IVpnPacketBufferList.

public : Buffer Buffer { get; }public Buffer Buffer { get; }Public ReadOnly Property Buffer As Buffer// This API is not available in Javascript.
Value
Buffer Buffer Buffer Buffer

The memory buffer object.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Status Status Status Status

Gets the status of VpnPacketBuffer. The status property may be used to report errors when manipulating the IVpnPacketBufferList.

public : VpnPacketBufferStatus Status { get; set; }public VpnPacketBufferStatus Status { get; set; }Public ReadWrite Property Status As VpnPacketBufferStatus// This API is not available in Javascript.
Value
VpnPacketBufferStatus VpnPacketBufferStatus VpnPacketBufferStatus VpnPacketBufferStatus

An enum value indicating the status of a VpnPacketBuffer object.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

TransportAffinity TransportAffinity TransportAffinity TransportAffinity

Gets or sets a number specifying which transport object to use as specified in the VpnChannel:Start* methods. This allows the selection between the main and the optional transports.

public : unsigned int TransportAffinity { get; set; }public uint TransportAffinity { get; set; }Public ReadWrite Property TransportAffinity As uint// This API is not available in Javascript.
Value
unsigned int uint uint uint

A value of 0 sets this packet to be sent over the main transport. A value of 1 sets this packet to be sent over the optional transport.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider