Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/04/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.30.27. qed::get_user_data (::quartus::qed)

The following table displays information for the qed::get_user_data Tcl command:

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::get_user_data [-h | -help] [-long_help] -key <key> <object>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-key <key> Arbitrary key to look up inside the user_data property of the selected object
<object> Identifier associated with the object, must be unique
Description
Reads the "user_data" property of an object as if it is a dict, and looks up
the value stored at the given key.

It is possible to use this command in conjunction with "qed::set_property -property user_data",
but whenever this method is invoked, any existing value must be a legal Tcl dictionary (which
includes the empty string). "qed::get_property -property user_data" returns the entire value
of the property instead of looking up a single key.
Example Usage
    qed::create_object -type project project_A
    qed::set_property -property user_data -value [dict create key_one value_1] project_A
    qed::set_user_data -key key_two -value value_2 project_A

    # Returns: {key_one value_1 key_two value_2}
    qed::get_property -property user_data project_A
    # Returns: value_1
    qed::get_user_data -key key_one project_A
    # Returns: value_2
    qed::get_user_data -key key_two project_A
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful