Click or drag to resize

TrackSetState Method (Byte, CancellationToken)

Sets the track's active state by value.

Namespace:  RRAutoLib.CTC
Assembly:  RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884
Syntax
Public Function SetState ( 
	bytStateValue As Byte,
	Optional sctCancelToken As CancellationToken = Nothing
) As Task(Of Boolean)

Parameters

bytStateValue
Type: SystemByte
A TrackTrackState member that is valid for this track type.
sctCancelToken (Optional)
Type: System.ThreadingCancellationToken
Token provided by a controlling source to notify this method that it should cancel its execution.

Return Value

Type: TaskBoolean
An awaitable Task returning True on success, otherwise False.

Implements

IPkStatesSetState(Byte, CancellationToken)
Remarks
The CtcService must be started otherwise a CtcIsStoppedException will be thrown.
See Also