API Component.GetInstance: Difference between revisions

← Older edit Newer edit →

Revision as of 08:20, 7 June 2013

<sidebar>API contents</sidebar> Gets the type-instance of the component, >= 1 is valid

Class hierarchy

Component

GetInstance

Parameters

HANDLE Target

The component to read the instance from

The default value for this parameter is: this

Return value

ULONG

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

@@ Line 22: / Line 22: @@
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+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 [[Component Tree|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.

JonnyW (talk | contribs)