ClientExtensionsFindHomeAsync(IDomeV2, CancellationToken, Int32, ILogger) Method

Returns an awaitable, running, Task that moves the dome to the home position

Definition

Namespace: ASCOM.Common
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea

C#

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

VB

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

Parameters

device IDomeV2: The Dome 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

Task
Awaitable task that ends when the dome is at its home position

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IDomeV2. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Initiator: FindHome

Complete when: Slewing is

Version Information

.NET Standard

Supported in: 2.0