overview
<p>An interface table that provides core host API functions for registering components and interfaces. </p>
Structure
<ac:structured-macro ac:name="code"><ac:plain-text-body><![CDATA[struct HostAPI
{
unsigned long dwSize;
unsigned long dwAPIVersion;
RegisterComponentFunc RegisterComponent;
RegisterInterfaceFunc RegisterInterface;
};]]></ac:plain-text-body></ac:structured-macro>
Members
<ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">dwSize</ac:parameter><ac:parameter ac:name="Type">unsigned long</ac:parameter><ac:parameter ac:name="Style">Member</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter><ac:rich-text-body><p>The size of the HostAPI structure in bytes. Provided by the framework; do not touch</p></ac:rich-text-body></ac:structured-macro><ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">dwAPIVersion</ac:parameter><ac:parameter ac:name="Type">unsigned long</ac:parameter><ac:parameter ac:name="Style">Member</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter><ac:rich-text-body><p>The version of the API that the host is using</p><div /></ac:rich-text-body></ac:structured-macro><ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">RegisterComponent</ac:parameter><ac:parameter ac:name="LinkedName">true</ac:parameter><ac:parameter ac:name="Linked">true</ac:parameter><ac:parameter ac:name="Type">RegisterComponentFunc</ac:parameter><ac:parameter ac:name="Style">Member</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter><ac:rich-text-body><p>Function pointer to the RegisterComponent function</p><div /></ac:rich-text-body></ac:structured-macro><ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">RegisterInterface</ac:parameter><ac:parameter ac:name="LinkedName">true</ac:parameter><ac:parameter ac:name="Linked">true</ac:parameter><ac:parameter ac:name="Type">RegisterInterfaceFunc</ac:parameter><ac:parameter ac:name="Style">Member</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter><ac:rich-text-body><p>Function pointer to the RegisterInterface function</p><div /></ac:rich-text-body></ac:structured-macro>
Remarks
<p>During initialisation of your component (via <ac:link><ri:page ri:content-title="Initialise" /></ac:link> or <ac:link><ri:page ri:content-title="InitialiseGUI" /></ac:link>) the host framework passes you a pointer to a HostAPI for you to use to access host functions. You should bind to the host by calling <ac:link><ri:page ri:content-title="WG_BIND_HOST" /></ac:link> with the passed in HostAPI pointer as a parameter.</p>
Examples
<p>See <ac:link><ri:page ri:content-title="WG_BIND_HOST" /></ac:link> for an example of binding to the host API</p>
SeeAlso
<p><ac:link><ri:page ri:content-title="WG_BIND_HOST" /></ac:link></p>