API Component.GetInstance: Difference between revisions
XML import |
No edit summary |
||
| Line 1: | Line 1: | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInstance''' | |||
=== | |- | ||
[[ | | colspan="2" | Gets the type-instance of the component, >= 1 is valid | ||
: | |- | ||
|- | |||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | Target | |||
== | |- | ||
[[ | | colspan="2" | The component to read the instance from | ||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
== | |||
[[ | |||
Revision as of 11:41, 16 January 2023
|
GetInstance |
| Gets the type-instance of the component, >= 1 is valid | |
 - HANDLE
|
Target |
| The component to read the instance from | |
 - ULONG
|
Return |
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 examples