From RTSC-Pedia

[printable version]  [offline version]

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

C - Object get

Get the instance handle of a statically created instance

Synopsis

#include <«pkg»/«Mod».h>
 
«Mod»_Handle «Mod»_Object_get(«Mod»_Object *array, Int index);

Description

This function is automatically defined for all target modules, where «Mod» is the name of some module. This function is typically used in situations where the «Mod» needs to loop over all statically created instances. If the first argument is NULL, «Mod»_Object_get() loops over the statically created instances created by «Mod».

for (i = 0; i < «Mod»_Object_count(); i++) {
    «Mod»_Handle h = «Mod»_Object_get(NULL, i);
        :  /* use «Mod» instance referenced by h */
}

Dynamically created instances are not returned by «Mod»_Object_get() and must be accessed via «Mod»_Object_first() and «Mod»_Object_next().

See also

[printable version]  [offline version]

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