dbGetPinFigPlacementStatus

dbGetPinFigPlacementStatus(
d_figId
)
=> t_pinFigPlacement / nil

Description

Returns the placement status for the specified pin figure.

If the placement status of the figure is equivalent to the placement status stored on the pin associated with figure, then a value is not stored on the figure and the returned value is retrieved from the pin.

Arguments

d_figId

The database ID of the figure that is attached to the pin.

Value Returned

t_pinFigPlacement	A string list indicating the placement status of the pin figure. Valid values: placed, unplaced, firm, fixed
nil	The SKILL function was not run successfully if the pin ID or figure IDs are invalid.

Example

foreach( fig setof(shape geGetEditCellView()~>shapes shape~>pin != nil) 
   status = dbGetPinFigPlacementStatus(fig)
   if( status != nil 
      printf("Pin fig placement status: %s\n" status) 
   )
)

Return to top