PC-DMIS 2019 R1 Object Library
FlowControlCmd Object Members
See Also  Overview  Send Topic Feedback | See Object Hierarchy Chart
PCDLRN ActiveX DLL : FlowControlCmd Object

Glossary Item Box

Public Methods

Public Method AddArgumentAdds or replaces an argument in objects of type CALL_SUBROUTINE and START_SUBROUTINE. When used with objects of other types, it has no effect.
Public Method AddSkipNum

Adds a number to be skipped to an object of type LOOP_START. For objects of other types, it does nothing.

This function returns TRUE if Number was successfully added to the LOOP_START object’s skip list, FALSE otherwise.

Public Method GetArgumentDescriptionReturns the description of an argument to an object of type START_SUBROUTINE. For objects of other types, it returns the empty string.
Public Method GetArgumentExpressionReturns the value or default value of an argument to an object of type CALL_SUBROUTINE or START_SUBROUTINE, respectively. For objects of other types, it returns the empty string.
Public Method GetArgumentNameReturns the name of an argument to an object of type START_SUBROUTINE. For objects of other types, it returns the empty string.
Public Method GetLeftSideOfExpressionFor FlowControlCmd objects of type ASSIGNMENT, this function returns the name of the variable being assigned to. For other types of objects, it returns an empty string.
Public Method GetRightSideOfExpressionFor FlowControlCmd objects of type ASSIGNMENT, this function returns the value being assigned to the variable. For other types of objects, it returns an empty string.
Public Method GetSkipNumThis function returns an integer. The integer is the nth skip number where n is indicated by the value of index.
Public Method IsExpressionValidTests whether or not the Expression is valid.
Public Method IsValidLeftHandValue

This function returns TRUE if the expression can be used as a valid left hand value (i.e. can be used on the left-hand side of an assignment statement), and FALSE otherwise.

Public Method IsValidSubroutineArgumentName

This function returns TRUE if the expression can be used as a valid subroutine argument name, and FALSE otherwise.

Public Method RemoveArgument

This function removes an argument from an object of type CALL_SUBROUTINE or START_SUBROUTINE. It returns TRUE if an argument is removed successfully, FALSE otherwise.

Public Method RemoveSkipNumThis function removes one of the skip numbers for the Loop Start object from the list of skip numbers. The number removed is determined by the index parameter.
Public Method SetArgumentDescriptionThis function sets the description of an argument of an object of type START_SUBROUTINE. It does nothing and returns FALSE if the object is not of this type. The function returns TRUE if the description was set successfully, FALSE otherwise.
Public Method SetArgumentExpressionThis function sets the value or default value of an argument of an object of type CALL_SUBROUTINE or START_SUBROUTINE, respectively. It does nothing and returns FALSE if the object is not one of these types.
Public Method SetArgumentNameThis function sets the name of an argument of an object of type START_SUBROUTINE. It does nothing and returns FALSE if the object is not of this type.
Public Method SetLeftSideOfAssignmentThe function sets the left-hand side of the Assign statement to the expression passed in. Use the function IsValidLeftHandValue to determine validity of expression for a left-hand side before using this function.
Public Method SetRightSideOfAssignmentThe function sets the right-hand side of the Assign statement to the expression passed in. Use the function IsExpressionValid to determine validity of expression before using this function.

Public Properties

Public Property AngleOffsetRepresents the angular offset of a LOOP_START object.
Public Property EndNumRead/Write: Loop Ending Number
Public Property ErrorModeRepresents the error mode of a ONERROR object.
Public Property ErrorTypeRepresents the error mode of a ONERROR object.
Public Property ExpressionRepresents the test expression of an IF_COMMAND object.
Public Property FileNameRepresents the file name of an external subroutine in a CALL_SUBROUTINE object.
Public Property IDRepresents the id of a CALL_SUBROUTINE object.
Public Property LabelRepresents the label associated with an object.
Public Property NumArgumentsReturns the number of arguments in a START_SUBROUTINE or CALL_SUBROUTINE object.
Public Property ReportAutoPrintReturns True if you have Hyper Report's Auto Print checkbox selected. False otherwise.
Public Property SkipCountReturns the number of skipped numbers in a LOOP_START object.
Public Property StartNumRepresents the start number of a LOOP_START object.
Public Property SubNameRepresents the subroutine name of a START_SUBROUTINE and CALL_SUBROUTINE object.
Public Property XAxisOffsetRepresents the X-axis offset of a LOOP_START object.
Public Property YAxisOffsetRepresents the Y-axis offset of a LOOP_START object.
Public Property ZAxisOffsetRepresents the Z-axis offset of a LOOP_START object.

See Also

Copyright © 2019. Hexagon Manufacturing Intelligence – Metrology Software, Inc. All Rights Reserved.