Edit

HcsEnumerateComputeSystems

  • Article

Description

Enumerates existing compute systems, see sample code.

Syntax

HRESULT WINAPI
HcsEnumerateComputeSystems(
    _In_opt_ PCWSTR        query,
    _In_     HCS_OPERATION operation
    );

Parameters

query

Optional JSON document of SystemQuery specifying a query for specific compute systems.

operation

The handle to the operation that tracks the enumerate operation.

Return Values

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

Operation Results

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

Operation Result Value Description
S_OK The operation was finished successfully, the result document returned by the hcs operation is a JSON document representing an array of compute system Properties

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