HcsModifyServiceSettings

Artigo
04/26/2022

Description

This function modifies the settings of the Host Compute System, see sample code.

Syntax

HRESULT WINAPI
HcsModifyServiceSettings(
    _In_ PCWSTR settings,
    _Outptr_opt_ PWSTR* result
    );

Parameters

settings

JSON document of ModificationRequest specifying the settings to modify.

result

On failure, it can optionally receive an error JSON document represented by a ResultError; it's not guaranteed to be always returned and depends on the property type that is being modified.

Return Values

The function returns HRESULT.

Remarks

The ModificationRequest JSON document has a property called "Settings" of type Any. In JSON, Any means an arbitrary object with no restrictions. Refer to the following table to know what JSON type HCS expects for each ModifyPropertyType.

`ModifyPropertyType`	`"Setting"` JSON Type
`"CpuGroup"`	HostProcessorModificationRequest
`"ContainerCredentialGuard"`	ContainerCredentialGuardOperationRequest

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