ClientExtensionsPositionSetAsync Method

Returns an awaitable, running, Task that moves the filter wheel to the specified filter wheel position

Definition

Namespace: ASCOM.Common
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public static Task PositionSetAsync(
	this IFilterWheelV2 device,
	int position,
	CancellationToken cancellationToken = default,
	int pollInterval = 1000,
	ILogger logger = null
)

Parameters

device  IFilterWheelV2
The FilterWheel device
position  Int32
The required filter wheel position
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 filter wheel is at the required position

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IFilterWheelV2. 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: Set Postion

Complete when: Get Position is zero or greater

Version Information

.NET Standard

Supported in: 2.0

See Also