...

Vardef

Name	hComponentPrivate
Linked	true
Type	ComponentContextHandle
Style	Member

Handle used by a component to associate itself with the host framework. You typically set this to the address of your own ComponentEntry.

Code Block

static ComponentEntry myComponent;
 
extern "C" __declspec(dllexport) int Initialise(HostAPI* pHost, HostModuleHandle hModule, LPCWSTR szRegistryPath)
{
// other initialisation ommitted
 
	myComponent.hComponentPrivate = &myComponent;
	
	return wgapi_RegisterComponent(hModule, &myComponent);
}

Vardef

Name	QueryInitInterfaces
LinkedName	true
Linked	true
Type	QueryInitInterfacesFunc
Style	Member

Pointer to the function to query whether the interfaces for the component can be initialised. See Remarks

Vardef

Name	InitInterfaces
LinkedName	true
Linked	true
Type	InitInterfacesFunc
Style	Member

Pointer to the function that initialises the component's interfaces. This will not be called by the framework unless QueryInitInterfaces has returned true;

Vardef

Name	ObtainInterface
LinkedName	true
Linked	true
Type	ObtainInterfaceFunc
Style	Member

TODO: What is this?

Vardef

Name	Notify
LinkedName	true
Linked	true
Type	NotifyFunc
Style	Member

Pointer to the function that receives notifications from the framework.

Vardef

Name	Start
LinkedName	true
Linked	true
Type	StartFunc
Style	Member

Starts the component

Vardef

Name	Stop
LinkedName	true
Linked	true
Type	StopFunc
Style	Member

Stops the component

Vardef

Name	Store
LinkedName	true
Linked	true
Type	StoreFunc
Style	Member

Instructs the component that it needs to store its configuration.

Vardef

Name	Load
LinkedName	true
Linked	true
Type	LoadFunc
Style	Member

Instructs the component that it needs to refresh its configuration.

Remarks

Anchor

	Remarks
	Remarks

...

Page tree

Versions Compared

Old Version 37

New Version 38

Key

Remarks

Page tree

Page History

Versions Compared

Old Version 37

New Version 38

Key

Remarks