ASCOM Library
Client
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: 4.0.0+77e18c564bf9ecdb0ef30166e894390d1b7d077c
Awaitable task that ends when the filter wheel is at the required position
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 4.0.0+77e18c564bf9ecdb0ef30166e894390d1b7d077c
C#
public static Task PositionSetAsync(
this IFilterWheelV2 device,
int position,
CancellationToken cancellationToken = default,
int pollInterval = 1000,
ILogger logger = null
)VB
<ExtensionAttribute>
Public Shared Function PositionSetAsync (
device As IFilterWheelV2,
position As Integer,
Optional cancellationToken As CancellationToken = Nothing,
Optional pollInterval As Integer = 1000,
Optional logger As ILogger = Nothing
) As TaskParameters
- 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
TaskAwaitable 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