API Component.GetInstance: Difference between revisions
XML import API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Gets the type-instance of the component, >= 1 is valid | Gets the type-instance of the component, >= 1 is valid | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Component | |||
::GetInstance | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Target'' | ''[[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''' | ||
==Return value== | |||
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
Returns the type-instance of the component, >= 1 is valid | Returns the type-instance of the component, >= 1 is valid | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetInstance(target)</pre> | ||
Revision as of 15:36, 11 May 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
Returns the type-instance of the component, >= 1 is valid
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::Component.GetInstance(target)