Click or drag to resize

SignalSetAspect Method (String, CancellationToken)

Sets the signal's active aspect by name.

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

Parameters

strAspectName
Type: SystemString
The aspect's Name.
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(String, CancellationToken)
Remarks
The CtcService must be started otherwise a CtcIsStoppedException will be thrown.
See Also