IVpnPlugIn.GetKeepAlivePayload(VpnChannel, VpnPacketBuffer) 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 compute and return a Keep alive payload ready to be sent to the VPN server.

public:
 void GetKeepAlivePayload(VpnChannel ^ channel, [Out] VpnPacketBuffer ^ & keepAlivePacket);

void GetKeepAlivePayload(VpnChannel const& channel, [Out] VpnPacketBuffer const& & keepAlivePacket);

public void GetKeepAlivePayload(VpnChannel channel, out VpnPacketBuffer keepAlivePacket);

Public Sub GetKeepAlivePayload (channel As VpnChannel, ByRef keepAlivePacket As VpnPacketBuffer)

Parameters

channel: VpnChannel

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

keepAlivePacket: VpnPacketBuffer

An VPN protocol specific message payload used by the VPN Plug-in to indicate to the server that the client and its VPN connection are still alive.

Windows requirements

App capabilities

networkingVpnProvider

Remarks

This method is only called at a time determined by the VPN infrastructure to be the optimal for the network in which the client machine is connected. If an error occurs the VPN infrastructure will skip sending the keep alive payload.

Applies to