IPsecSaContextCreate0 (Compact 2013)

  • Article

3/26/2014

This function creates an IPsec security association (SA) context.

Syntax

DWORD IPsecSaContextCreate0(
  __in       HANDLE engineHandle,
  __in       const IPSEC_TRAFFIC0* outboundTraffic,
  __out_opt  UINT64* inboundFilterId,
  __out      UINT64* id
);

Parameters

  • engineHandle
    A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
  • outboundTraffic
    An IPSEC_TRAFFIC0 structure that describes the outbound traffic of the SA.
  • inboundFilterId
    Optional filter identifier of the cached inbound filter corresponding to the outboundTraffic parameter specified by the caller. Base filtering engine (BFE) may cache the inbound filter identifier and return the cached value, if available. Caller must handle the case when BFE does not have a cached value, in which case this parameter will be set to 0.
  • id
    The identifier of the IPsec SA context.

Return Value

Return code / value

Description

ERROR_SUCCESS

0

The IPsec SA context was created successfully.

FWP_E_* error code

0x80320001-0x80320039

A Windows Filtering Platform (WFP) specific error. See topic 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 transaction. It will fail with FWP_E_TXN_IN_PROGRESS.

This function cannot be called from within a dynamic session. The call will fail with FWP_E_DYNAMIC_SESSION_IN_PROGRESS. See topic WFP Object Management for more information about dynamic sessions.

The caller needs FWPM_ACTRL_ADD access to the IPsec security association database. See WFP Access Right Identifiers for more information.

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP IPsec Functions
WFP Access Right Identifiers

Other Resources

Windows Filtering Platform