VgaGames 3 - VgaGames3-object man-pages

[.. upper level ..]

VG3_ofunc_objlist_isvalid()

Return an object-instance from the list of VgaGames3-objects via an instance-ID.
SYNTAX
struct vg3_ofunc_object * VG3_ofunc_objlist_isvalid(struct vg3_ofunc *ofstruct, unsigned int instanceid)

FUNCTION PARAMETERS
ofstruct Common VgaGames3-object structure
instanceid Instance-ID of the object-instance

RETURN VALUE
Returns the pointer to the object-instance or NULL if not found.

DESCRIPTION
As object-instances can be removed from the list of VgaGames3-objects, it is advisable to save the instance-ID of an object-instance rather than the pointer to it. With this function the object-instance is returned by its instance-ID, if existing.

SEE ALSO
VG3_ofunc_objlist_insert() VG3_ofunc_objlist_remove() VG3_ofunc_objlist_find_obj()