Method
FoundryCliCommandTreeregister_full
unstable since: 1.2
Declaration [src]
void
foundry_cli_command_tree_register_full (
FoundryCliCommandTree* self,
const char* const* path,
const FoundryCliCommand* command,
const char* summary,
const char* arguments
)
Description [src]
Registers command at path with separate help metadata.
The summary should be a short verb phrase without positional argument
syntax. The arguments should contain only positional arguments because
the generated help adds option syntax automatically.
Available since: 1.2
Parameters
path-
Type: An array of
char*The command path.
The array must be NULL-terminated.The data is owned by the caller of the method. Each element is a NUL terminated UTF-8 string. command-
Type:
FoundryCliCommandThe command implementation.
The data is owned by the caller of the method. summary-
Type:
const char*A short summary of the command, or
NULLto preserve an existing group summary.The argument can be NULL.The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string. arguments-
Type:
const char*The command’s positional argument synopsis.
The argument can be NULL.The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string.