Difference between revisions of "API Component.GetInstance"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
|||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Target'' |
:The component to read the instance from | :The component to read the instance from | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| Line 16: | Line 16: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|ULONG]] |
Returns the type-instance of the component, >= 1 is valid | Returns the type-instance of the component, >= 1 is valid | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Gets the type-instance of the component, >= 1 is valid
Contents
Parameters
HANDLE Target
- The component to read the instance from
- The default value for this parameter is: this
Return value
Returns the type-instance of the component, >= 1 is valid
Detailed description
A components instance is a number referring to how many occurrences of a component exist before this one, including itself. The number is 1 if the component is the first of its type to be added.
This instance number is irrespective of the depth of a component - a component of the same type as the Target is still considered even if it is embedded deep in some other components tree.
Note this call relies on a match of the components GUID, so built-in component types (such as shapes and groups) do not have an instance and it will return zero.
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::Component.GetInstance(target)
No additional information
