FGGet Method

Description
Acquires a result of a Force Guide sequence or Force Guide object.

Syntax
Sub FGGet (Sequence As String, [Object As String], Property As SpelForceProps, ByRef Result As Boolean)
Sub FGGet (Sequence As String, [Object As String], Property As SpelForceProps, ByRef Result As Double)
Sub FGGet (Sequence As String, [Object As String], Property As SpelForceProps, ByRef Result As Integer)s
Sub FGGet (Sequence As String, [Object As String], Property As SpelForceProps, ByRef Result As String)

Parameters

  • Sequence
    Force guide sequence name or string variable indicating the Force Guide sequence name
  • Object
    Force guide object name or string variable indicating the Force Guide object name. Omitted when acquiring the result of a Force Guide sequence.
  • Property
    Result name to acquire the value
  • Result
    Variable indicating the returned value. The number and type vary according to the result.

See Also
FGRun Method

FGGet Example
VB Example:

Dim val As Integer  
m_spel.MotorsOn = True  
  
m_spel.FGRun("Sequence1")  
m_spel.FGGet("Sequence1","", SpelForceProps.EndStatus, val)  

C# Example:

int errCode;  
m_spel.MotorsOn = true;  
  
m_spel.FGRun("Sequence1");  
m_spel.FGGet("Sequence1","", SpelForceProps.EndStatus, val);