IPsecSaContextAddOutbound0 function (fwpmu.h)

  • Article

The IPsecSaContextAddOutbound0 function adds an outbound IPsec security association (SA) bundle to an existing SA context.

Note  IPsecSaContextAddOutbound0 is the specific implementation of IPsecSaContextAddOutbound used in Windows Vista. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7 and later, IPsecSaContextAddOutbound1 is available.
 

Syntax

DWORD IPsecSaContextAddOutbound0(
  [in] HANDLE                 engineHandle,
  [in] UINT64                 id,
  [in] const IPSEC_SA_BUNDLE0 *outboundBundle
);

Parameters

[in] engineHandle

Type: HANDLE

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

[in] id

Type: UINT64

Identifier for the existing IPsec SA context. This is the value returned in the id parameter by the call to IPsecSaContextCreate0.

[in] outboundBundle

Type: IPSEC_SA_BUNDLE0*

The outbound IPsec SA bundle to be added to the SA context.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The IPsec SA bundle was successfully added to the SA context.
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.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

IPSEC_SA_BUNDLE0

IPsecSaContextCreate0