Method SetAdminSettingsAsync

Namespace

Kepware.Api.ClientHandler

Assembly

Kepware.Api.dll

SetAdminSettingsAsync(AdminSettings, CancellationToken)

Updates the administrator settings with the specified values.

public Task<bool> SetAdminSettingsAsync(AdminSettings settings, CancellationToken cancellationToken = default)

Parameters

settings AdminSettings

The new administrator settings to apply.

cancellationToken CancellationToken

A token that can be used to request cancellation of the operation.

Returns

Task<bool>

True if the settings were successfully updated; otherwise, false.

Exceptions

InvalidOperationException

Thrown if the current settings cannot be retrieved.