Scripting

cmp remove_assignment (Tcl Script API Function)



The cmp remove_assignment function has the following format:

Syntax cmp remove_assignment <section_identifier> <source> <destination> <variable> <value>
Arguments

<section_identifier>

The name of the section in the Compiler Settings File (.csf) that contains the assignment. If you want to remove the assignment from all possible sections in the CSF, use empty double quotation marks ("").

<source>

If required, the first statement in a range of statements that contain the assignment. If there is no range, or you want to remove all statements with the assignment, use empty double quotation marks ("").

<destination>

The statement containing the assignment, or, for a range of statements, the last statement in the range. If you want to remove all statements with the assignment, use empty double quotation marks ("").

<variable>

The keyword for the assignment you want to remove.

<value>

The value of the assignment you want to remove.

Return Value
Code Name Code String Return
TCL_OK 0 assignment removed
TCL_ERROR 1 unable to remove compiler setting assignment(s)
TCL_ERROR 1 project has no active compiler setting
TCL_ERROR 1 no project is currently open
TCL_ERROR 1 no assignment removed because it did not exist
TCL_ERROR 1 wrong # args: should be "remove_assignment section_id source destination variable value"
TCL_ERROR 1 section identifier is required but was not specified
TCL_ERROR 1 section identifier was specified but is not required
TCL_ERROR 1 illegal or missing destination
TCL_ERROR 1 unable to write to disk
Description Removes the specified assignment (by removing the specified statement(s) that contain the assignment) from the specified section(s) of the project's current CSF.
To remove an entire section from the CSF, specify the <section_identifier> and use empty double quotation marks ("") for <variable>.


Back to Top

- PLDWorld -

 

Created by chm2web html help conversion utility.