API Component.GetInstance

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

	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)