Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kApiLib_Construct ( kAssembly assembly)

Constructs the Zen API type assembly (kApiLib).

This function initializes the Zen API assembly and returns a handle that represents the assembly. When the assembly is no longer needed, pass the assembly handle to the kObject_Destroy function.

This function should be called prior to calling most other Zen API functions. The only exceptions to this rule are kApiLib functions that configure global handlers (e.g. kApiLib_SetMemAllocHandlers); these functions should typically be called prior to kApiLib_Construct.

Multiple nested calls to this function will return the same assembly instance. To ensure final clean up, the kObject_Destroy function should be invoked a corresponding number of times on the assembly handle.

Parameters
assemblyReceives a handle to the kApiLib type assembly.
Returns
Operation status.