Registers a new component with the host framework.

Syntax

int RegisterComponent(
HostModuleHandle module,
ComponentEntry* entry
);

 

Parameters

Internally managed handle of the module to register this component under. Calls to Initialise and InitialiseGUI are passed a HostModuleHandle that is created and managed by the framework. Pass this same handle to RegisterComponent. e.g.

static ComponentEntry ourComponent;
 
extern "C" __declspec(dllexport) int Initialise(HostAPI* pHost, HostModuleHandle hModule, LPCWSTR szRegistryPath)
{
	// Initialisation of ourComponent removed for brevity 

	return RegisterComponent(hModule, &ourComponent);
}

Pointer to the ComponentEntry object that you wish to register.

Non-zero if the component is registered successfully, or zero if registration failed.

 

Remarks

Examples

Requirements

See Also

ComponentEntry

HostModuleHandle