HcsShutDownComputeSystem

Description

Cleanly shuts down a compute system.

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

computeSystem

The handle to the compute system to shut down.

operation

The handle to the operation that tracks the shutdown operation.

options

Reserved for future use. Must be NULL.

The function returns HRESULT.

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.

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

Operation Result Value	Description
`S_OK`	The compute system shut down successfully
`HCS_E_SYSTEM_ALREADY_STOPPED`	The operation failed if there is duplicate shutdown or terminate for same compute system