ClientExtensionsHaltAsync(IRotatorV3, CancellationToken, Int32, ILogger) Method

public static Task HaltAsync(
	this IRotatorV3 device,
	CancellationToken cancellationToken = default,
	int pollInterval = 1000,
	ILogger logger = null
)

<ExtensionAttribute>
Public Shared Function HaltAsync ( 
	device As IRotatorV3,
	Optional cancellationToken As CancellationToken = Nothing,
	Optional pollInterval As Integer = 1000,
	Optional logger As ILogger = Nothing
) As Task

Parameters

device  IRotatorV3

The Rotator device

cancellationToken  CancellationToken  (Optional)

Cancellation token - Default: None

pollInterval  Int32  (Optional)

Interval between polls of the completion variable (milliseconds) - Default: 1000 milliseconds.

logger  ILogger  (Optional)

ILogger instance that will receive operation messages from the method - Default: No logger

Return Value

Usage Note

Initiator: Halt

Complete when: IsMoving is

Reference