Share via

FwpmTransactionBegin0 (Compact 2013)

  • Article

3/26/2014

This function begins an explicit transaction within the current session.

Syntax

DWORD FwpmTransactionBegin0(
  __in  HANDLE engineHandle,
  __in  UINT32 flags
);

Parameters

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

  • flags
    When the flag value is zero, begin a read/write transaction.

    When the flag value is FWPM_TXN_READ_ONLY, begin a read-only transaction.

Return Value

Return code / value

Description

ERROR_SUCCESS

0

The transaction was started 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.

For a read-only transaction, the caller needs FWPM_ACTRL_BEGIN_READ_TXN access to the filter engine. For a read/write transaction, the caller needs FWPM_ACTRL_BEGIN_WRITE_TXN access to the filter engine. See WFP Access Right Identifiers for more information.

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP Transaction Management
WFP Access Right Identifiers
WFP Management Functions

Other Resources

Windows Filtering Platform