From RTSC-Pedia

[printable version]  [offline version]

offline version generated on 04-Aug-2010 21:08 UTC

C - Instance finalize

Module's instance finalization function

Synopsis

#include "package/internal/«Mod».xdc.h"
 
Void «Mod»_Instance_finalize(«Mod»_Object *obj)            /* non-@InstanceInitError modules only */
Void «Mod»_Instance_finalize(«Mod»_Object *obj, Int state) /* @InstanceInitError modules only */

Description

Modules that support instances and are specified with the @InstanceFinalize attribute must implement this function, where «Mod» is the name of the module. The type signature of this function depends on whether (or not) «Mod» has the @InstanceInitError attribute. If «Mod» is declared with @InstanceInitError, this function is passed a second integer parameter, state. The state parameter's value is either the return value from a failed «Mod»_Instance_init() call or 0 (in the case of a normal instance delete, for example).

See also