qed::list_properties (::quartus::qed)
The following table displays information for the qed::list_properties Tcl command:
Tcl Package and Version |
Belongs to ::quartus::qed 1.0 |
|||
Syntax | qed::list_properties [-h | -help] [-long_help] [-set_only] [-writeable_only] <object> | |||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-set_only | Flag indicating that any unset property names should be filtered out. | |||
-writeable_only | Flag indicating that read-only property names should be filtered out. | |||
<object> | Identifier associated with the object, must be unique | |||
Description |
Returns a list of valid properties for the given object. When you create an object, some of its properties may not be set; they may have no value and no default value. When you use the "-set_only" option, the list of properties returned is limited to properties that are set. Some object properties are read-only, and the rest are read/write. When you use the "-writeable_only" option, the list of properties returned is limited to properties that are read/write. This is a utility command that makes it easier to find out what properties are valid for the given object. |
|||
Example Usage |
qed::create_object -type project project_A -user_data {this is some data!} qed::list_properties project_A -writeable_only qed::create_object -type group group_one -projects {project_A} qed::list_properties group_one -set_only |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful |