FWPM_SESSION0 structure

The FWPM_SESSION0 structure defines session-specific parameters for an open session to the filter engine.

Note  FWPM_SESSION0 is a specific version of FWPM_SESSION. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Syntax


typedef struct FWPM_SESSION0_ {
  GUID               sessionKey;
  FWPM_DISPLAY_DATA0 displayData;
  UINT32             flags;
  UINT32             txnWaitTimeoutInMSec;
  DWORD              processId;
  SID                *sid;
  wchar_t            *username;
  BOOL               kernelMode;
} FWPM_SESSION0;

Members

sessionKey

A callout driver-defined GUID that uniquely identifies the open session to the filter engine. If a callout driver zero-initializes this GUID prior to opening the session, the filter engine will generate a unique GUID when the session is opened.

displayData

An FWPM_DISPLAY_DATA0 structure that specifies a name and a description for the open session to the filter engine.

flags

Flags that specify the session-specific parameters. Possible flags are:

FWPM_SESSION_FLAG_DYNAMIC

If this flag is set, any filters, providers, provider contexts, or callouts that are added to the filter engine during the open session will be automatically removed from the filter engine when the session is closed. No filters, providers, provider contexts, or callouts can be deleted during the open session except for those that are added during the session.

txnWaitTimeoutInMSec

The time, in milliseconds, that the callout driver will wait to begin a transaction with the filter engine before a time-out occurs. If a callout driver specifies zero for this member, a default time-out value will be used.

processId

This member is not used when a callout driver specifies an FWPM_SESSION0 structure when opening a session to the filter engine.

sid

This member is not used when a callout driver specifies an FWPM_SESSION0 structure when opening a session to the filter engine.

username

This member is not used when a callout driver specifies an FWPM_SESSION0 structure when opening a session to the filter engine.

kernelMode

This member is not used when a callout driver specifies an FWPM_SESSION0 structure when opening a session to the filter engine.

Remarks

A callout driver can pass a pointer to an FWPM_SESSION0 structure to the FwpmEngineOpen0 function to specify session-specific parameters for the session to the filter engine.

Requirements

Version

Available starting with Windows Vista.

Header

Fwpmtypes.h (include Fwpmk.h)

See also

FWPM_DISPLAY_DATA0
FwpmEngineOpen0

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft