IVpnPlugIn.Encapsulate Method

Reference

Definition

Namespace:: Windows.Networking.Vpn

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

This method instructs the VPN plug-in to prepare the indicated L3 IP packet for transmission to the VPN server. The process might include any encapsulation specific to the VPN protocol.

public:
 void Encapsulate(VpnChannel ^ channel, VpnPacketBufferList ^ packets, VpnPacketBufferList ^ encapulatedPackets);

void Encapsulate(VpnChannel const& channel, VpnPacketBufferList const& packets, VpnPacketBufferList const& encapulatedPackets);

public void Encapsulate(VpnChannel channel, VpnPacketBufferList packets, VpnPacketBufferList encapulatedPackets);

function encapsulate(channel, packets, encapulatedPackets)

Public Sub Encapsulate (channel As VpnChannel, packets As VpnPacketBufferList, encapulatedPackets As VpnPacketBufferList)

Parameters

channel: VpnChannel

The VPN channel object representing the instance VPN connection of the VPN plug-in to the VPN server.

packets: VpnPacketBufferList

An L3 IP packets originated by the client machine TCP/IP stack and that needs to be processed to be sent to the corporate network.

encapulatedPackets: VpnPacketBufferList

Windows requirements

App capabilities

networkingVpnProvider

Remarks

If an error occurs the packets will simply be dropped. It is required that any IVpnPacketBuffer object, either passed to the method in the packets parameter or requested by the plugin, be returned to the VPN framework. The VPN framework will then send the IVpnPacketBuffer objects in encapsulatedPackets via one of the transports specified during Connect and will clean up the remaining IVpnPacketBuffer objects in packets.

Applies to