IProcessSnapshot Interface

This interface is implemented by a process snapshot object. Use the IProcessWindow.createSnapshot method to create a snapshot and get a reference to this interface.

Declaration

interface IProcessSnapshot {
    // Properties
    readonly ${isSnapshot}: boolean;
    readonly ${date}?: Date;

    // Methods
    ${openRegion}(start?: number, size?: number, readOnly?: boolean): ${IDocument};
    ${delete}(): void;
    ${saveDump}(path: string, includeFullMemory = false): Promise<void>;
    ${debug}(debuggerType: ${DebuggerType}, includeFullMemory = false): void;
}

// This interface is not available in managed environment

// This interface is not available in native environment

IProcessSnapshot Properties

isSnapshot

readonly isSnapshot: boolean;

// This property is not available in managed environment

// This property is not available in native environment

This property is true if the object represents a process snapshot and false if it represents a running process.

date

readonly date?: Date;

// This property is not available in managed environment

// This property is not available in native environment

The date and time of the snapshot creation. This property returns undefined if the object represents a running process.

IProcessSnapshot Methods

openRegion

openRegion(start?: number, size?: number, readOnly?: boolean): ${IDocument};

// This method is not available in managed environment

// This method is not available in native environment

start: A starting offset in the process address space you want to open.
size: A size of the memory window you want to open.
readOnly: true to open a read-only view on the process memory and false to enable write access. This parameter is not applicable if opening process snapshots (they are always opened as read-only).

Opens the specified process memory of a current snapshot or running process in the editor. If both start and size are omitted, then the whole process space is opened.

delete

delete(): void;

// This method is not available in managed environment

// This method is not available in native environment

Delete the current snapshot.

saveDump

saveDump(path: string, includeFullMemory = false): Promise<void>;

// This method is not available in managed environment

// This method is not available in native environment

path: A full path to the dump file.
includeFullMemory: true to include all process memory in the dump. false only includes private process memory. Setting this parameter to true results in much larger dump size and longer execution.

Save a dump of the current process snapshot (or running process) to a given file.

debug

debug(debuggerType: ${DebuggerType}, includeFullMemory = false): void;

// This method is not available in managed environment

// This method is not available in native environment

debuggerType: The type of the debugger to use.
includeFullMemory: true to include all process memory in the dump. false only includes private process memory. Setting this parameter to true results in much larger dump size and longer execution.

Launch an external debugger and attach it to a given process snapshot or a running process.

IDocument DebuggerType