Initialize properties to common defaults

Name

ggiGAClearCarbProperties, ggiGAClearMotorProperties, ggiGAClearTankProperties : Initialize properties to common defaults

Synopsis

#include <ggi/galloc.h>

int ggiGAClearMotorProperties(struct ggiGA_resource_props *prop);

int ggiGAClearCarbProperties(struct ggiGA_resource_props *prop);

int ggiGAClearTankProperties(struct ggiGA_resource_props *prop);

Description

These functions initialize the properties for common use of any resource type but specific to the resource variants motor, carb or tank.

If there is a more special function to the resource type provided by an extension, then it is recommended to use them instead. They can initialize more structure fields to default values that makes sense that specific resource type, but common to any kind of that resource type.

Example: libggibuf(7) provides ggiBufClearMotorProperties(3), ggiBufClearCarbProperties(3) and ggiBufClearTankProperties(3). They initialize the property structure additionaly with default values special to the resource type buffer and common for any buffer subtype.

Return value

They return GALLOC_OK on success or an gg-error(3) code otherwise.

See Also