ASCOM Library
Client
Returns an awaitable, running, Task that sets the switch to a given boolean state
Definition
Namespace: ASCOM.Common
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 4.0.0+77e18c564bf9ecdb0ef30166e894390d1b7d077c
Awaitable task that ends when the switch has changed to the designated state
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 4.0.0+77e18c564bf9ecdb0ef30166e894390d1b7d077c
C#
public static Task SetAsync(
this ISwitchV3 device,
short id,
bool state,
CancellationToken cancellationToken = default,
int pollInterval = 1000,
ILogger logger = null
)VB
<ExtensionAttribute>
Public Shared Function SetAsync (
device As ISwitchV3,
id As Short,
state As Boolean,
Optional cancellationToken As CancellationToken = Nothing,
Optional pollInterval As Integer = 1000,
Optional logger As ILogger = Nothing
) As TaskParameters
- device ISwitchV3
- The Switch device
- id Int16
- The switch ID number
- state Boolean
- The desired boolean state
- 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 switch has changed to the designated state
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type ISwitchV3. 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: SetAsync(Int16, Boolean)
Complete when: StateChangeComplete(Int16) is
Only available for ISwitchV3 and later devices.