get_gui_custom_command_args - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Get custom command arguments


get_gui_custom_command_args ‑command_name <arg> [‑regexp] [‑nocase]
    [‑quiet] [‑verbose] [<patterns>...]


List of custom command argument names.


Name Description
-command_name Unique name of the custom command whose arguments need to be displayed.
[-regexp] Patterns are full regular expressions
[-nocase] Perform case-insensitive matching (valid only when -regexp specified)
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match the custom command argument names against patterns Default: *




Returns the list of GUI custom command argument names for a particular GUI custom command.

You can use get_gui_custom_commands to determine the list of defined custom commands.


-command_name - The name of the custom GUI command whose arguments should be returned.

-regexp - (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter expressions must be written as regular expressions when this argument is used. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See for help with regular expression syntax.
Note: The Tcl built-in command regexp is not anchored, and works as a standard Tcl command. For more information refer to

-nocase - (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp only.

-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.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<patterns> - (Optional) Match custom GUI command arguments against the specified patterns. The default pattern is the wildcard '*' which returns all arguments for the custom GUI command.


The following example returns a list of command arguments for the GUI custom command abc:

get_gui_custom_command_args -command_name abc