Method GetChannelAsync

Namespace

Kepware.Api.ClientHandler

Assembly

Kepware.Api.dll

GetChannelAsync(string, CancellationToken)

Gets a channel with the specified name and driver.

public Task<Channel?> GetChannelAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the channel.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<Channel>

A task that represents the asynchronous operation. The task result contains the loaded Channel or null if it does not exist.

Exceptions

ArgumentException

Thrown when the channel name or driver name is null or empty.