OhioScreenWaitForHostUpdateAsync Method

Waits for the host to send new screen data. For character based VT emulations, other wait functions such as WaitForStrRecvAsync or WaitForCursorColumnAsync should be used instead.

Namespace: Flex.Hal.Ohio
Assembly: Flex.Hal.Ohio (in Flex.Hal.Ohio.dll) Version: 6.0.8219.1880

Syntax

Copy

public Task<bool> WaitForHostUpdateAsync(
	CancellationToken canceltoken = default
)

Public Function WaitForHostUpdateAsync ( 
	Optional canceltoken As CancellationToken = Nothing
) As Task(Of Boolean)

Parameters

canceltoken CancellationToken (Optional): Token to cancel the wait.

Return Value

TaskBoolean
True if host data is received before a time-out or cancellation; otherwise, false.

Exceptions

Exception	Condition
TimeoutException	WaitThrowException is enabled and a time-out occurs.
OperationCanceledException	WaitThrowException is enabled and a cancellation occurs.

Reference

OhioScreen Class

Flex.Hal.Ohio Namespace