gclass_command_desc()

Retrieves the data description of a command in a given gclass. If name is NULL, it returns the full command table.

C

Prototype

const sdata_desc_t *gclass_command_desc(
    hgclass gclass,
    const char *name,
    BOOL verbose
);

Parameters

Key	Type	Description
gclass	hgclass	The gclass whose command description is to be retrieved.
name	const char *	The name of the command to retrieve. If NULL, returns the full command table.
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

If verbose is TRUE and the command is not found, an error message is logged.

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