HcsGetComputeSystemProperties

Artigo
04/26/2022

Description

Returns properties of a compute system, see sample code for simple example.

Syntax

HRESULT WINAPI
HcsGetComputeSystemProperties(
    _In_  HCS_SYSTEM computeSystem,
    _In_  HCS_OPERATION operation,
    _In_opt_ PCWSTR propertyQuery
    );

Parameters

computeSystem

The handle to the compute system to query.

operation

The handle to the operation that tracks the query operation.

propertyQuery

Optional JSON document of System_PropertyQuery specifying the properties to query.

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 a compute system's Properties. Compute system Id and SystemType will always be returned.

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

Compartilhar via