HcsPauseComputeSystem

Description

Pauses the execution of a compute system, see sample code.

Syntax

HRESULT WINAPI
HcsPauseComputeSystem(
    _In_ HCS_SYSTEM computeSystem,
    _In_ HCS_OPERATION operation,
    _In_opt_ PCWSTR options
    );

Parameters

computeSystem

The handle to the compute system to pause.

operation

The handle to the operation that tracks the pause operation.

options

Optional JSON document of PauseOptions specifying pause options.

Return Values

The function returns HRESULT, refer to hcs operation async model.

If the return value is S_OK, it means the operation started successfully. Callers are expected to get the operation's result using HcsWaitForOperationResult or HcsGetOperationResult.

Operation Results

The return value of HcsWaitForOperationResult or HcsGetOperationResult based on current operation listed as below.

Operation Result Value	Description
S_OK	The compute system was paused successfully

Requirements

Parameter	Description
Minimum supported client	Windows 10, version 1809
Minimum supported server	Windows Server 2019
Target Platform	Windows
Header	ComputeCore.h
Library	ComputeCore.lib
Dll	ComputeCore.dll