Collapse All Expand All

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

AddArgument | Adds or replaces an argument in objects of type CALL_SUBROUTINE and START_SUBROUTINE. When used with objects of other types, it has no effect.
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.
GetArgumentDescription | Returns the description of an argument to an object of type START_SUBROUTINE. For objects of other types, it returns the empty string.
GetArgumentExpression | Returns 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.
GetArgumentName | Returns the name of an argument to an object of type START_SUBROUTINE. For objects of other types, it returns the empty string.
GetLeftSideOfExpression | For 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.
GetRightSideOfExpression | For 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.
GetSkipNum | This function returns an integer. The integer is the nth skip number where n is indicated by the value of index.
IsExpressionValid | Tests whether or not the Expression is valid.
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.
IsValidSubroutineArgumentName | This function returns TRUE if the expression can be used as a valid subroutine argument name, and FALSE otherwise.
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.
RemoveSkipNum | This 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.
SetArgumentDescription | This 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.
SetArgumentExpression | This 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.
SetArgumentName | This 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.
SetLeftSideOfAssignment | The 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.
SetRightSideOfAssignment | The 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

AngleOffset | Represents the angular offset of a LOOP_START object.
EndNum | Read/Write: Loop Ending Number
ErrorMode | Represents the error mode of a ONERROR object.
ErrorType | Represents the error mode of a ONERROR object.
Expression | Represents the test expression of an IF_COMMAND object.
FileName | Represents the file name of an external subroutine in a CALL_SUBROUTINE object.
ID | Represents the id of a CALL_SUBROUTINE object.
Label | Represents the label associated with an object.
NumArguments | Returns the number of arguments in a START_SUBROUTINE or CALL_SUBROUTINE object.
ReportAutoPrint | Returns True if you have Hyper Report's Auto Print checkbox selected. False otherwise.
SkipCount | Returns the number of skipped numbers in a LOOP_START object.
StartNum | Represents the start number of a LOOP_START object.
SubName | Represents the subroutine name of a START_SUBROUTINE and CALL_SUBROUTINE object.
XAxisOffset | Represents the X-axis offset of a LOOP_START object.
YAxisOffset | Represents the Y-axis offset of a LOOP_START object.
ZAxisOffset | Represents the Z-axis offset of a LOOP_START object.

# See Also

FlowControlCmd Object

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