set_parameter (::quartus::project)

Tcl Package and Version

Syntax

set_parameter [-h | -help] [-long_help] [-comment <comment> ] [-disable] [-fall] -name <name> [-remove] [-rise] [-tag <data> ] [ <value> ]

Arguments

-h | -help

Short help

-long_help

Long help with examples and possible return values

-comment <comment>

Comment

-disable

Option to disable parameter

-fall

Option applies to falling edge

-name <name>

Parameter name

-remove

Option to remove parameter

-rise

Option applies to rising edge

-tag <data>

Option to tag data to this assignment

<value>

Parameter value

Description

Sets or removes the specified parameter name.

The "-name" option is not case sensitive.

The parameters created or modified by using this Tcl command are
not saved to the Quartus Prime Settings File (.qsf) unless you
explicitly call one of the following two Tcl commands:

1) export_assignments
2) project_close (unless "-dont_export_assignments" is specified)

These two Tcl commands reside in the ::quartus::project Tcl 
package. You must save assignment changes before you run 
Quartus Prime command-line executables. Note, however, that 
the Tcl commands "execute_flow" and "execute_module" (part 
of the ::quartus::flow Tcl package) automatically call 
"export_assignments" before they run command-line executables.

set_parameter can be used to overwrite the parameters in the top-level
entity of the design. A warning will be given if the parameter 
can not be applied.

set_parameter assignments with "-entity" and "-to" are ignored and 
a critical warning is given if they are used.

Example Usage

## Set project-wide, default WIDTH parameter value
set_parameter -name WIDTH 8

Return Value

Code Name

Code

String Return

TCL_OK

0

INFO: Operation successful

TCL_OK

0

INFO: Removed parameter: <string>

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: Can't run Tcl command while a process is in progress: <string>. To run the command, stop the compilation or simulation; or wait for the compilation or simulation to complete.

TCL_ERROR

1

ERROR: Value <string> for <string> assignment is illegal. Specify a legal value.

TCL_ERROR

1

ERROR: You must open a project before you can use this command.

TCL_ERROR

1

ERROR: The -<string> option is not required but was specified with the value: <string>. Delete the option.

TCL_ERROR

1

ERROR: The -<string> option is required but was not specified. Specify the required option.

TCL_ERROR

1

ERROR: Parameter does not exist and cannot be removed: <string>. Specify an existing parameter name.

TCL_ERROR

1

ERROR: An unknown error has occured.

TCL_ERROR

1

ERROR: Missing <<string>> for <string> assignment. Specify the required <string>.

Tcl Package and Version	Belongs to ::quartus::project 6.0
Syntax	`set_parameter [-h \| -help] [-long_help]` `[-comment` <comment> `]` `[-disable]` `[-fall]` `-name` <name> `[-remove]` `[-rise]` `[-tag` <data> `]` `[` <value> `]`
Arguments	`-h \| -help`		Short help
	`-long_help`		Long help with examples and possible return values
	`-comment` <comment>		Comment
	`-disable`		Option to disable parameter
	`-fall`		Option applies to falling edge
	`-name` <name>		Parameter name
	`-remove`		Option to remove parameter
	`-rise`		Option applies to rising edge
	`-tag` <data>		Option to tag data to this assignment
	<value>		Parameter value
Description	Sets or removes the specified parameter name. The "-name" option is not case sensitive. The parameters created or modified by using this Tcl command are not saved to the Quartus Prime Settings File (.qsf) unless you explicitly call one of the following two Tcl commands: 1) export_assignments 2) project_close (unless "-dont_export_assignments" is specified) These two Tcl commands reside in the ::quartus::project Tcl package. You must save assignment changes before you run Quartus Prime command-line executables. Note, however, that the Tcl commands "execute_flow" and "execute_module" (part of the ::quartus::flow Tcl package) automatically call "export_assignments" before they run command-line executables. set_parameter can be used to overwrite the parameters in the top-level entity of the design. A warning will be given if the parameter can not be applied. set_parameter assignments with "-entity" and "-to" are ignored and a critical warning is given if they are used.
Example Usage	## Set project-wide, default WIDTH parameter value set_parameter -name WIDTH 8
Return Value	Code Name	Code	String Return
	TCL_OK	0	INFO: Operation successful
	TCL_OK	0	INFO: Removed parameter: <string>
	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: Can't run Tcl command while a process is in progress: <string>. To run the command, stop the compilation or simulation; or wait for the compilation or simulation to complete.
	TCL_ERROR	1	ERROR: Value <string> for <string> assignment is illegal. Specify a legal value.
	TCL_ERROR	1	ERROR: You must open a project before you can use this command.
	TCL_ERROR	1	ERROR: The -<string> option is not required but was specified with the value: <string>. Delete the option.
	TCL_ERROR	1	ERROR: The -<string> option is required but was not specified. Specify the required option.
	TCL_ERROR	1	ERROR: Parameter does not exist and cannot be removed: <string>. Specify an existing parameter name.
	TCL_ERROR	1	ERROR: An unknown error has occured.
	TCL_ERROR	1	ERROR: Missing <<string>> for <string> assignment. Specify the required <string>.