Difference between revisions of "Arw GetSize"
Jump to navigation
Jump to search
(Created page with "Returns a numerical value indicating the size of the arrow contained in an arrow object with the specified ID number; returns a value of -2 if the specified object ID number i...") |
|||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Returns a numerical value indicating the size of the arrow contained in an arrow object with the specified ID number | + | Returns a numerical value indicating the size of the arrow contained in an arrow object with the specified ID number. |
| + | |||
| + | Arw_GetSize returns a value of -2 if the specified object ID number is invalid. | ||
| − | + | == Usage == | |
<syntaxhighlight>Arw_GetSize(ObjectID)</syntaxhighlight> | <syntaxhighlight>Arw_GetSize(ObjectID)</syntaxhighlight> | ||
| − | Where: ObjectID - a numerical expression specifying the object ID number | + | Where: |
| + | |||
| + | :'''ObjectID''' - a numerical expression specifying the object ID number. | ||
| − | + | == Notes == | |
| − | An object-specific ID number is | + | * An object-specific ID number is assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created. |
| − | + | * Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow. | |
| − | + | ||
| + | == Example == | ||
Assign a value, indicating the size of the arrow in an arrow object with the ID number of 3, to Value1 variable: | Assign a value, indicating the size of the arrow in an arrow object with the ID number of 3, to Value1 variable: | ||
| − | <syntaxhighlight>Value1=Arw_GetSize(3);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Arw_GetSize(3);</syntaxhighlight> |
| − | |||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 08:16, 19 February 2012
Returns a numerical value indicating the size of the arrow contained in an arrow object with the specified ID number.
Arw_GetSize returns a value of -2 if the specified object ID number is invalid.
Usage
Arw_GetSize(ObjectID)
Where:
- ObjectID - a numerical expression specifying the object ID number.
Notes
- An object-specific ID number is assigned by Arw_New, Arw_New_s, Arw_New_self or Arw_New_self_s when the arrow object is created.
- Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.
Example
Assign a value, indicating the size of the arrow in an arrow object with the ID number of 3, to Value1 variable:
Value1 = Arw_GetSize(3);
