PC-Dmis 2010 MR3 Object Library | Send comments on this topic. | See Object Hierarchy Chart
FlowControlCmd Object Members
See Also Overview

Collapse All Expand All

# Public Methods

AddArgument | Adds argument to argument list 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 skip number to loop skip list 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 | Gets description of specified argument Returns the description of an argument to an object of type START_SUBROUTINE. For objects of other types, it returns the empty string.
GetArgumentExpression | Gets expression text of specified argument 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 name of specified argument Returns the name of an argument to an object of type START_SUBROUTINE. For objects of other types, it returns the empty string.
GetLeftSideOfExpression | Gets expression text for left side of assignment 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 | Gets expression text for right side of assignment 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 | Get skip number value This function returns an integer. The integer is the nth skip number where n is indicated by the value of index.
IsExpressionValid | Determines whether provided expression text is valid Tests whether or not the Expression is valid.
IsValidLeftHandValue | Determines if expression if a valid expression for left side of assignment command 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 | Determines if expression a is valid name for subroutine argument This function returns TRUE if the expression can be used as a valid subroutine argument name, and FALSE otherwise.
RemoveArgument | Removes argument 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 | Remove skip number 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 | Sets description of specified argument 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 | Sets expression text of specified argument 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 | Sets name of specified argument 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 | Sets expression for left side of assignment command 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 | Sets expression for right side of assignment command 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 | Read/Write: Loop Angle Offset Represents the angular offset of a LOOP_START object.
EndNum | Read/Write: Loop Ending Number
ErrorMode | Read/Write: On Error Error Mode Represents the error mode of a ONERROR object.
ErrorType | Read/Write: On Error Error Type Represents the error mode of a ONERROR object.
Expression | Read/Write: Expression Represents the test expression of an IF_COMMAND object.
FileName | Read/Write: Filename Represents the file name of an external subroutine in a CALL_SUBROUTINE object.
ID | Read/Write: Flow Control Command ID Represents the id of a CALL_SUBROUTINE object.
Label | Read/Write: Label ID Represents the label associated with an object.
NumArguments | Read Only: Number of Arguments Returns the number of arguments in a START_SUBROUTINE or CALL_SUBROUTINE object.
ReportAutoPrint | Read/Write: Hyper Report Auto Print Setting Returns True if you have Hyper Report's Auto Print checkbox selected. False otherwise.
SkipCount | Read Only: Number of skip numbers in loop command Returns the number of skipped numbers in a LOOP_START object.
StartNum | Read/Write: Loop Starting Number Represents the start number of a LOOP_START object.
SubName | Read/Write: Subroutine Name Represents the subroutine name of a START_SUBROUTINE and CALL_SUBROUTINE object.
XAxisOffset | Read/Write: Loop X Axis Offset Represents the X-axis offset of a LOOP_START object.
YAxisOffset | Read/Write: Loop Y Axis Offset Represents the Y-axis offset of a LOOP_START object.
ZAxisOffset | Read/Write: Loop Z Axis Offset Represents the Z-axis offset of a LOOP_START object.

# See Also

FlowControlCmd Overview

© Wilcox Associates, Inc. All Rights Reserved.

© 2010 All Rights Reserved.