Description
Get properties of object.
Syntax
get_property [-min] [-max] [-quiet] [-verbose] <name> <object>
Returns
Property value.
Usage
Name | Description |
---|---|
[-min ] |
Return only the minimum value |
[-max ] |
Return only the maximum value |
[-quiet ] |
Ignore command errors |
[-verbose ] |
Suspend message limits during command execution |
<name> | Name of property whose value is to be retrieved |
<object> | Object to query for properties |
Categories
Object, PropertyAndParameter
Description
Gets the current value of the named property from the specified object or objects. If multiple objects are specified, a list of values is returned.
If the property is not currently assigned to the object, or is
assigned without a value, then the get_property
command returns
nothing, or the null string. If multiple objects are queried, the null string is
added to the list of values returned.
This command returns a value, or list of values, or returns an error if it fails.
Arguments
-min
- (optional) When multiple
objects are specified, this option examines the values of the named property, and
returns the smallest value from the list of objects. Numeric properties are sorted
by value. All other properties are sorted as strings.
-max
- (optional) When multiple
objects are specified, this option examines the values of the named property, and
returns the largest value from the list of objects. Numeric properties are sorted by
value. All other properties are sorted as strings.
-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.
name
- (required) The name of the
property to be returned. The name is not case sensitive.
object
- (required) One or more objects to examine
for the specified property.
Examples
Get the NAME property from the specified cell:
common::get_property NAME [lindex [get_cells] 0]
Get the BOARD property from the current hardware design:
common::get_property BOARD [current_hw_design]