Create a custom command argument for a custom command in the GUI
Syntax
create_gui_custom_command_arg ‑command_name <arg> ‑arg_name <arg>
[‑default <arg>] [‑comment <arg>] [‑optional] [‑quiet] [‑verbose]Usage
| Name | Description |
|---|---|
-command_name
|
Unique name of the custom command for which an argument is being created. |
-arg_name
|
Unique name of the custom command argument to create. |
[-default]
|
Default value of the custom command argument. |
[-comment]
|
Comment for the custom command argument. |
[-optional]
|
Make the custom command argument optional. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
Categories
Description
This commands defines an argument for a specific custom GUI command.
You can use the get_gui_custom_commands to determine the list of defined custom commands. You can use the get_gui_custom_command_args to determine the list of defined GUI custom command arguments of a particular GUI custom command.
Arguments
-command_name - (Required) The name of the custom GUI command to create an argument for.
-arg_name - (Required) The unique name of the argument to create.
-default - (Optional) Specifies a default value for the argument.
-comment - (Optional) Comment for the custom command argument.
-optional - (Optional) Make the custom command argument optional.
-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config command.Examples
print_version. The argument is defined as optional and its default value is -quiet.
create_gui_custom_command_arg -command_name print_version -arg_name quiet \
-default "-quiet" -comment "Ignore commands errors" -optional