Edit

FWPM_SESSION0 structure (fwpmtypes.h)

  • Article

The FWPM_SESSION0 structure stores the state associated with a client session.

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

Uniquely identifies the session.

If this member is zero in the call to FwpmEngineOpen0, Base Filtering Engine (BFE) will generate a GUID.

displayData

Allows sessions to be annotated in a human-readable form.

See FWPM_DISPLAY_DATA0 for more information.

flags

Settings to control session behavior.

Session flag Meaning
FWPM_SESSION_FLAG_DYNAMIC
 When this flag is set, any objects added during the session are automatically deleted when the session ends.
FWPM_SESSION_FLAG_RESERVED
 Reserved.

txnWaitTimeoutInMSec

Time in milli-seconds that a client will wait to begin a transaction.

If this member is zero, BFE will use a default timeout.

processId

Process ID of the client.

sid

SID of the client.

username

User name of the client.

kernelMode

TRUE if this is a kernel-mode client.

Remarks

This structure contains information supplied by the client when creating a session by calling FwpmEngineOpen0, or information retrieved from the system when enumerating sessions by calling FwpmSessionEnum0.

The members processId, sid, username, and kernelMode are not supplied by the client. They are supplied by BFE and can be retrieved when enumerating sessions.

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

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header fwpmtypes.h

See also

FWPM_DISPLAY_DATA0

FwpmEngineOpen0

FwpmSessionEnum0

Windows Filtering Platform API Structures