Share via

FWPM_SESSION0 (Compact 7)

  • Article

3/12/2014

This 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 topic FWPM_DISPLAY_DATA0 for more information.

  • flags
    Settings to control session behavior. When this flag is set to FWPM_SESSION_FLAG_DYNAMIC, any objects added during the session are automatically deleted when the session ends.

  • 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 that is supplied by the client when it creates a session, or information retrieved from the system when sessions are enumerated.

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

Requirements

Header

fwpmu.h

See Also

Reference

WFP Management Structures

Other Resources

Windows Filtering Platform