ddRegHiddenCellsFunc

ddRegHiddenCellsFunc( 
s_hiddenCellsFunc 
[ t_libName] 
) 
=> t / nil 

Description

Registers a user-defined SKILL function that will be called to obtain a list of hidden cell names. Note that additionally the Virtuoso environment considers a cell to be hidden if it is a member of the Hidden category or its subcategories.

Hidden cell functions should be registered using the .cdsinit file so that hidden cells are available during Virtuoso startup for tools such as Library Manager.

Arguments

t_hiddenCellsFunc	Name of a user-defined SKILL function to be registered. The function should accept the ddID of a library and return a list of hidden cells names. Once the hidden cells are obtained for a library using a hidden cells function, the information is cached until a refresh is done from the Library Manager or Virtuoso CIW or a ddUpdateLibList call is made.
t_libName	Name of a library. If a name is specified, the registered function applies to only the specified library. Otherwise, the function applies to all libraries in the DDPI library list.

Value Returned

t	The function was registered.
nil	The function was not registered. The function specified might not exist or be callable.

Example

Consider the  myHiddenCellsFunc function, which hides cells that start with an underscore (_) in the myLib library:

procedure(myHiddenCellsFunc(libId)
 setof(cellName libId~>cells~>name strncmp(cellName "_" 1) == 0)
)

Register the myHiddenCellsFunc function as follows:

ddRegHiddenCellsFunc('myHiddenCellsFunc "myLib")

Related Topics

ddUpdateLibList

Return to top