Edit

Share via

PssWalkMarkerCreate function (processsnapshot.h)

  • Article

Creates a walk marker.

Syntax

DWORD PssWalkMarkerCreate(
  [in, optional] PSS_ALLOCATOR const *Allocator,
  [out]          HPSSWALK            *WalkMarkerHandle
);

Parameters

[in, optional] Allocator

A structure that provides functions to allocate and free memory. If you provide the structure, PssWalkMarkerCreate uses the functions to allocate the internal walk marker structures. Otherwise it uses the default process heap. For more information, see PSS_ALLOCATOR.

[out] WalkMarkerHandle

A handle to the walk marker that this function creates.

Return value

This function returns ERROR_SUCCESS on success or the following error code.

Return code Description
ERROR_NOT_ENOUGH_MEMORY
 Could not allocate memory for the walk marker.
 

All error codes are defined in winerror.h. Use FormatMessage with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a message for an error code.

Remarks

The walk marker maintains the state of a walk, and can be used to reposition or rewind the walk.

The Allocator structure that provides the custom functions should remain valid for the lifetime of the walk marker. The custom functions are called from PssWalkMarkerCreate, PssWalkMarkerFree and PssWalkSnapshot using the same thread that calls PssWalkMarkerCreate, PssWalkMarkerFree and PssWalkSnapshot. Therefore the custom functions need not be multi-threaded.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header processsnapshot.h
DLL Kernel32.dll

See also

Process Snapshotting