Skip to main content
FwpmIPsecTunnelAdd0 function

The FwpmIPsecTunnelAdd0 function adds a new Internet Protocol Security (IPsec) tunnel mode policy to the system.

Note  FwpmIPsecTunnelAdd0 is the specific implementation of FwpmIPsecTunnelAdd used in Windows Vista. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, FwpmIPsecTunnelAdd1 is available. For Windows 8, FwpmIPsecTunnelAdd2 is available.

Syntax


DWORD WINAPI FwpmIpsecTunnelAdd0(
  _In_      HANDLE engineHandle,
  _In_      UINT32 flags,
  _In_opt_  const FWPM_PROVIDER_CONTEXT0 *mainModePolicy,
  _In_      const FWPM_PROVIDER_CONTEXT0 *tunnelPolicy,
  _In_      UINT32 numFilterConditions,
  _In_      const FWPM_FILTER_CONDITION0 *filterConditions,
  _In_opt_  PSECURITY_DESCRIPTOR sd
);

Parameters

engineHandle [in]

Type: HANDLE

A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

flags [in]

Type: UINT32

Possible values:

IPsec tunnel flagMeaning
FWPM_TUNNEL_FLAG_POINT_TO_POINT

Adds a point-to-point tunnel to the system.

 

mainModePolicy [in, optional]

Type: const FWPM_PROVIDER_CONTEXT0*

The Main Mode policy for the IPsec tunnel.

tunnelPolicy [in]

Type: const FWPM_PROVIDER_CONTEXT0*

The Quick Mode policy for the IPsec tunnel.

numFilterConditions [in]

Type: UINT32

Number of filter conditions present in the filterConditions parameter.

filterConditions [in]

Type: const FWPM_FILTER_CONDITION0*

Array of filter conditions that describe the traffic which should be tunneled by IPsec.

sd [in, optional]

Type: PSECURITY_DESCRIPTOR

The security information associated with the IPsec tunnel.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The IPsec tunnel mode policy was successfully added.

FWP_E_INVALID_PARAMETER
0x80320035

FWPM_TUNNEL_FLAG_POINT_TO_POINT was not set and conditions other than local/remote address were specified.

FWP_E_* error code
0x80320001—0x80320039

A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details.

RPC_* error code
0x80010001—0x80010122

Failure to communicate with the remote or local firewall engine.

 

Remarks

This function cannot be called from within a read-only transaction. It will fail with FWP_E_INCOMPATIBLE_TXN. See Object Management for more information about transactions.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FWPM_PROVIDER_CONTEXT0
FWPM_FILTER_CONDITION0