remove_gui_custom_command_args - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Remove one or more custom command arguments

Syntax

remove_gui_custom_command_args ‑command_name <arg> [‑quiet] [‑verbose]
    <names>...

Usage

Name Description
-command_name name of custom command whose arguments are being removed.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<names> name of one or more custom command arguments to remove.

Categories

GUIControl

Description

Remove one or more GUI custom command arguments of a particular GUI custom command.

You can use get_gui_custom_commands to determine the list of defined custom commands. You can use get_gui_custom_command_args to determine the list of defined GUI custom command arguments for a particular GUI custom command.

Arguments

-command_name - (Required) Specifies the name of GUI custom command whose arguments are being removed.

-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.

<names> - (Required) One or more argument names to remove.

Examples

Remove GUI custom command arguments with name 'arg1' and 'arg2' of a GUI custom command with name 'cmd_1' :

remove_gui_custom_command_args -command_name cmd_1 {arg1 arg2}