odcRegisterCustomFunc

odcRegisterCustomFunc( 
t_odcObjType
t_functionText
) 
=> t / nil

Description

Allows you to define a custom SKILL function to specify your own information to be displayed in the Info Balloon box for the specified object type.

Arguments

t_odcObjType	The object type for which the customFunc will be invoked. Valid values are: (“Rectangle”, ”Polygon”, “Path”, ”MPP”, ”PathSeg”, “Circle”, “Ellipse”, “Donut”, “Label”, “TextDisplay”, “Instance”, “Blockage”, “Row”, “Boundary”, “Via”, “Custom Placement Area”, “Marker”, “Pin”, “Modgen”, “Ruler”)
t_functionText	The name of the function to be executed for objects of specified odcObjType.

Value Returned

t	The function is successfully registered.
nil	The function is not successfully registered.

Examples

To define the SKILL extension to return the custom information string:

procedure(customFunc(dbId @optional hierPath)
let((skillStr)
printf("=== input parameter: %L\n" dbId)
; need to return a SKILL string
skillStr = "test custom \n SKILL function\n"
skillStr
); let
)

To register the SKILL extension as a custom SKILL function:

odcRegisterCustomFunc("Pin" "customFunc")

Related Topics

Using the SKILL Extension

Return to top