techCreatePurpose

techCreatePurpose( 
d_techID
x_purposeNumber
t_purposeName 
[ t_purposeAbbrev ]
) 
=> t / nil

Description

Creates a purpose in the specified technology database. ASCII technology file location: techPurposes subsection in the layerDefinitions section; it lists the layer purposes used with technology data. If a techPurposes subsection does not exist, this function creates one with the specified data.

Applications that display purpose names do not always have room to display the entire name. The optional abbreviation expands your control over what is displayed in narrow fields. Depending upon the width of the field for displaying the purpose name, an application displays whichever of the following fits:

• The full purpose name
• The abbreviation
• The first and last letters of the full purpose name

For more information about techPurposes, see techPurposes in Virtuoso Technology Data ASCII Files Reference.

Arguments

d_techID	The database identifier of the technology database.
x_purposeNumber	The purpose number. Valid values: A unique integer, 1 through 128 and 256 through 232-65535.
t_purposeName	The purpose name. Valid values: Any string
t_purposeAbbrev	The optional purpose abbreviation. Valid values: Any string of seven characters or less

Value Returned

t	The purpose was successfully created.
nil	The technology database does not exist; the purpose is not created.

Example

techCreatePurpose(techID 10 "drawing" "dwg")
=> t

Creates a purpose with the purpose number 10, the purpose name drawing, and the purpose abbreviation dwg.

Return to top