Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/2021

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

Document Table of Contents get_parameter (::quartus::project)

The following table displays information for the get_parameter Tcl command:

Tcl Package and Version

Belongs to ::quartus::project

Syntax get_parameter [-h | -help] [-long_help] [-entity <entity_name> ] [-fall] -name <name> [-rise] [-tag <data> ] [-to <destination> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-entity <entity_name> Entity to which parameter belongs
-fall Option applies to falling edge
-name <name> Parameter name
-rise Option applies to rising edge
-tag <data> Option to tag data to this assignment
-to <destination> Destination of parameter

Returns the value of the parameter. The "-name" option is not case sensitive. The "-to" option is case sensitive. If the "-to" argument is specified, the function returns the parameter value for the current entity. The value is retrieved from the PARAMETERS section of the entity. Otherwise, the function returns the project-wide default parameter value obtained from the DEFAULT_PARAMETERS section. Use the "-entity" option to retrieve the parameter from the specified entity. If the "-entity" option is not specified, the value for the FOCUS_ENTITY_NAME assignment is used. If the FOCUS_ENTITY_NAME value is not found, the revision name is used.

Example Usage
## Get project-wide, default parameter value
get_parameter -name WIDTH

## Get entity-specific parameter value
get_parameter -name inst1 -to SIZE
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Can't find active revision name. Make sure there is an open, active revision name.
TCL_ERROR 1 ERROR: Entity does not exist or uses illegal name characters: <string>. Specify a legal entity name.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.
TCL_ERROR 1 ERROR: Illegal default parameter: <string>. Specify a legal default parameter name.
TCL_ERROR 1 ERROR: Illegal pa