dbSetPinFigPlacementStatus

dbSetPinFigPlacementStatus(
d_figId
g_placementStat
)
=> t / nil

Description

Specifies the placement status for the given pin figure.

If there is an override value on the figure which is different from the value stored on the pin associated with the figure and the figure is the only figure of its pin then the pin~>status is updated; otherwise, the value is stored locally with the figure.

Arguments

d_figId	The database ID of the pin figure that is attached to the pin.
g_placementStat	A string list indicating the placement status for the pin figure. Valid values: placed, unplaced, firm, none The default is none.

Value Returned

t	The SKILL function was run successfully.
nil	The SKILL function was not run successfully if the pin ID or figure IDs are invalid.

Example

dbSetPinFigPlacementStatus(figId "placed") t

Return to top