Skip to content

Latest commit

 

History

History
174 lines (115 loc) · 9.19 KB

ne-processsnapshot-pss_capture_flags.md

File metadata and controls

174 lines (115 loc) · 9.19 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NE:processsnapshot.PSS_CAPTURE_FLAGS
PSS_CAPTURE_FLAGS (processsnapshot.h)
Flags that specify what PssCaptureSnapshot captures.
PSS_CAPTURE_FLAGS
PSS_CAPTURE_FLAGS enumeration
PSS_CAPTURE_HANDLES
PSS_CAPTURE_HANDLE_BASIC_INFORMATION
PSS_CAPTURE_HANDLE_NAME_INFORMATION
PSS_CAPTURE_HANDLE_TRACE
PSS_CAPTURE_HANDLE_TYPE_SPECIFIC_INFORMATION
PSS_CAPTURE_NONE
PSS_CAPTURE_RESERVED_00000002
PSS_CAPTURE_RESERVED_00000400
PSS_CAPTURE_THREADS
PSS_CAPTURE_THREAD_CONTEXT
PSS_CAPTURE_THREAD_CONTEXT_EXTENDED
PSS_CAPTURE_VA_CLONE
PSS_CAPTURE_VA_SPACE
PSS_CAPTURE_VA_SPACE_SECTION_INFORMATION
PSS_CREATE_BREAKAWAY
PSS_CREATE_BREAKAWAY_OPTIONAL
PSS_CREATE_FORCE_BREAKAWAY
PSS_CREATE_MEASURE_PERFORMANCE
PSS_CREATE_RELEASE_SECTION
PSS_CREATE_USE_VM_ALLOCATIONS
proc_snap.pss_capture_flags
processsnapshot/PSS_CAPTURE_FLAGS
processsnapshot/PSS_CAPTURE_HANDLES
processsnapshot/PSS_CAPTURE_HANDLE_BASIC_INFORMATION
processsnapshot/PSS_CAPTURE_HANDLE_NAME_INFORMATION
processsnapshot/PSS_CAPTURE_HANDLE_TRACE
processsnapshot/PSS_CAPTURE_HANDLE_TYPE_SPECIFIC_INFORMATION
processsnapshot/PSS_CAPTURE_NONE
processsnapshot/PSS_CAPTURE_RESERVED_00000002
processsnapshot/PSS_CAPTURE_RESERVED_00000400
processsnapshot/PSS_CAPTURE_THREADS
processsnapshot/PSS_CAPTURE_THREAD_CONTEXT
processsnapshot/PSS_CAPTURE_THREAD_CONTEXT_EXTENDED
processsnapshot/PSS_CAPTURE_VA_CLONE
processsnapshot/PSS_CAPTURE_VA_SPACE
processsnapshot/PSS_CAPTURE_VA_SPACE_SECTION_INFORMATION
processsnapshot/PSS_CREATE_BREAKAWAY
processsnapshot/PSS_CREATE_BREAKAWAY_OPTIONAL
processsnapshot/PSS_CREATE_FORCE_BREAKAWAY
processsnapshot/PSS_CREATE_MEASURE_PERFORMANCE
processsnapshot/PSS_CREATE_RELEASE_SECTION
processsnapshot/PSS_CREATE_USE_VM_ALLOCATIONS
proc_snap\pss_capture_flags.htm
proc_snap
6146DDA2-2475-45F8-86F3-65791B10743D
12/05/2018
PSS_CAPTURE_FLAGS, PSS_CAPTURE_FLAGS enumeration, PSS_CAPTURE_HANDLES, PSS_CAPTURE_HANDLE_BASIC_INFORMATION, PSS_CAPTURE_HANDLE_NAME_INFORMATION, PSS_CAPTURE_HANDLE_TRACE, PSS_CAPTURE_HANDLE_TYPE_SPECIFIC_INFORMATION, PSS_CAPTURE_NONE, PSS_CAPTURE_RESERVED_00000002, PSS_CAPTURE_RESERVED_00000400, PSS_CAPTURE_THREADS, PSS_CAPTURE_THREAD_CONTEXT, PSS_CAPTURE_THREAD_CONTEXT_EXTENDED, PSS_CAPTURE_VA_CLONE, PSS_CAPTURE_VA_SPACE, PSS_CAPTURE_VA_SPACE_SECTION_INFORMATION, PSS_CREATE_BREAKAWAY, PSS_CREATE_BREAKAWAY_OPTIONAL, PSS_CREATE_FORCE_BREAKAWAY, PSS_CREATE_MEASURE_PERFORMANCE, PSS_CREATE_RELEASE_SECTION, PSS_CREATE_USE_VM_ALLOCATIONS, proc_snap.pss_capture_flags, processsnapshot/PSS_CAPTURE_FLAGS, processsnapshot/PSS_CAPTURE_HANDLES, processsnapshot/PSS_CAPTURE_HANDLE_BASIC_INFORMATION, processsnapshot/PSS_CAPTURE_HANDLE_NAME_INFORMATION, processsnapshot/PSS_CAPTURE_HANDLE_TRACE, processsnapshot/PSS_CAPTURE_HANDLE_TYPE_SPECIFIC_INFORMATION, processsnapshot/PSS_CAPTURE_NONE, processsnapshot/PSS_CAPTURE_RESERVED_00000002, processsnapshot/PSS_CAPTURE_RESERVED_00000400, processsnapshot/PSS_CAPTURE_THREADS, processsnapshot/PSS_CAPTURE_THREAD_CONTEXT, processsnapshot/PSS_CAPTURE_THREAD_CONTEXT_EXTENDED, processsnapshot/PSS_CAPTURE_VA_CLONE, processsnapshot/PSS_CAPTURE_VA_SPACE, processsnapshot/PSS_CAPTURE_VA_SPACE_SECTION_INFORMATION, processsnapshot/PSS_CREATE_BREAKAWAY, processsnapshot/PSS_CREATE_BREAKAWAY_OPTIONAL, processsnapshot/PSS_CREATE_FORCE_BREAKAWAY, processsnapshot/PSS_CREATE_MEASURE_PERFORMANCE, processsnapshot/PSS_CREATE_RELEASE_SECTION, processsnapshot/PSS_CREATE_USE_VM_ALLOCATIONS
processsnapshot.h
Windows
Windows 8.1 [desktop apps only]
Windows Server 2012 R2 [desktop apps only]
Windows
PSS_CAPTURE_FLAGS
19H1
PSS_CAPTURE_FLAGS
processsnapshot/PSS_CAPTURE_FLAGS
c++
APIRef
kbSyntax
HeaderDef
processsnapshot.h
PSS_CAPTURE_FLAGS

PSS_CAPTURE_FLAGS enumeration

-description

Flags that specify what PssCaptureSnapshot captures.

-enum-fields

-field PSS_CAPTURE_NONE:0x00000000

Capture nothing.

-field PSS_CAPTURE_VA_CLONE:0x00000001

Capture a snapshot of all cloneable pages in the process. The clone includes all MEM_PRIVATE regions, as well as all sections (MEM_MAPPED and MEM_IMAGE) that are shareable. All Win32 sections created via CreateFileMapping are shareable.

-field PSS_CAPTURE_RESERVED_00000002:0x00000002

(Do not use.)

-field PSS_CAPTURE_HANDLES:0x00000004

Capture the handle table (handle values only).

-field PSS_CAPTURE_HANDLE_NAME_INFORMATION:0x00000008

Capture name information for each handle.

-field PSS_CAPTURE_HANDLE_BASIC_INFORMATION:0x00000010

Capture basic handle information such as HandleCount, PointerCount, GrantedAccess, etc.

-field PSS_CAPTURE_HANDLE_TYPE_SPECIFIC_INFORMATION:0x00000020

Capture type-specific information for supported object types: Process, Thread, Event, Mutant, Section.

-field PSS_CAPTURE_HANDLE_TRACE:0x00000040

Capture the handle tracing table.

-field PSS_CAPTURE_THREADS:0x00000080

Capture thread information (IDs only).

-field PSS_CAPTURE_THREAD_CONTEXT:0x00000100

Capture the context for each thread.

-field PSS_CAPTURE_THREAD_CONTEXT_EXTENDED:0x00000200

Capture extended context for each thread (e.g. CONTEXT_XSTATE).

-field PSS_CAPTURE_RESERVED_00000400:0x00000400

(Do not use.)

-field PSS_CAPTURE_VA_SPACE:0x00000800

Capture a snapshot of the virtual address space. The VA space is captured as an array of MEMORY_BASIC_INFORMATION structures. This flag does not capture the contents of the pages.

-field PSS_CAPTURE_VA_SPACE_SECTION_INFORMATION:0x00001000

For MEM_IMAGE and MEM_MAPPED regions, dumps the path to the file backing the sections (identical to what GetMappedFileName returns). For MEM_IMAGE regions, also dumps:

  • IMAGE_NT_HEADERS.FileHeader.TimeDateStamp
  • IMAGE_NT_HEADERS.OptionalHeader.SizeOfImage
  • IMAGE_NT_HEADERS.OptionalHeader.ImageBase
  • IMAGE_NT_HEADERS.OptionalHeader.CheckSum
The PROCESS_VM_READ access right is required on the process handle.
Warning  This option is only valid when PSS_CAPTURE_VA_SPACE is specified.
 

-field PSS_CAPTURE_IPT_TRACE:0x00002000

-field PSS_CREATE_BREAKAWAY_OPTIONAL:0x04000000

The breakaway is optional. If the clone process fails to create as a breakaway, then it is created still inside the job. This flag must be specified in combination with either PSS_CREATE_FORCE_BREAKAWAY and/or PSS_CREATE_BREAKAWAY.

-field PSS_CREATE_BREAKAWAY:0x08000000

The clone is broken away from the parent process' job. This is equivalent to CreateProcess flag CREATE_BREAKAWAY_FROM_JOB.

-field PSS_CREATE_FORCE_BREAKAWAY:0x10000000

The clone is forcefully broken away the parent process's job. This is only allowed for Tcb-privileged callers.

-field PSS_CREATE_USE_VM_ALLOCATIONS:0x20000000

The facility should not use the process heap for any persistent or transient allocations. The use of the heap may be undesirable in certain contexts such as creation of snapshots in the exception reporting path (where the heap may be corrupted).

-field PSS_CREATE_MEASURE_PERFORMANCE:0x40000000

Measure performance of the facility. Performance counters can be retrieved via PssQuerySnapshot with the PSS_QUERY_PERFORMANCE_COUNTERS information class of PSS_QUERY_INFORMATION_CLASS.

-field PSS_CREATE_RELEASE_SECTION:0x80000000

The virtual address (VA) clone process does not hold a reference to the underlying image. This will cause functions such as QueryFullProcessImageName to fail on the VA clone process.

Important  

This flag has no effect unless PSS_CAPTURE_VA_CLONE is specified.

 

-remarks

If both PSS_CREATE_FORCE_BREAKAWAY and PSS_CREATE_BREAKAWAY are specified, then PSS_CREATE_FORCE_BREAKAWAY takes precedence.

-see-also

Process Snapshotting