gobj_attr_desc()

`gobj_attr_desc()`#

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

C

Prototype

const sdata_desc_t *gobj_attr_desc(
    hgobj gobj, 
    const char *attr, 
    BOOL verbose
);

Parameters

Key	Type	Description
`gobj`	`hgobj`	The gobj whose attribute description is to be retrieved.
`attr`	`const char *`	The name of the attribute. If NULL, the function 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 attribute description (sdata_desc_t *). Returns 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