gclass_attr_desc()

`gclass_attr_desc()`#

Retrieves the attribute description of a given gclass. If attr is NULL, it returns the full attribute table.

C

Prototype

const sdata_desc_t *gclass_attr_desc(
    hgclass gclass, 
    const char *attr, 
    BOOL verbose
);

Parameters

Key	Type	Description
`gclass`	`hgclass`	The `gclass` whose attribute description is to be retrieved.
`attr`	`const char *`	The name of the attribute to retrieve. If NULL, returns the full attribute table.
`verbose`	`BOOL`	If TRUE, logs an error message when the attribute is not found.

Return Value

A pointer to the sdata_desc_t structure describing the attribute, or NULL if the attribute is not found.

Notes

If verbose is set to TRUE and the attribute is not found, an error message is logged.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python