gobj_command_desc()

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

C

Prototype

PUBLIC const sdata_desc_t *gobj_command_desc(
    hgobj gobj,
    const char *name,
    BOOL verbose
);

Parameters

Key	Type	Description
gobj	hgobj	The gobj instance whose command description is to be retrieved.
name	const char *	The name of the command. If NULL, the full command table is returned.
verbose	BOOL	If TRUE, logs an error message when the command is not found.

---

Return Value

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

Notes

This function first checks if the gobj is valid. If the command name is NULL, it returns the full command table. Otherwise, it searches for the specific command in the gobj’s gclass.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples