schGetCellViewListInSearchScope
schGetCellViewListInSearchScope(
d_cvId
t_scope
d_topCV
t_viewNameList
t_libName
t_mode
)
=> l_cvList / nil
Description
Returns a list of cellviews in the search scope you specify. Only cellviews of the same view type as the base cellview are returned.
Arguments
|
d_cvId
|
Cellview ID of the schematic or symbol cellview in which to base the search. d_cvId must be a schematic or symbol cellview. Hierarchy is not supported for symbol cellviews.
|
|
t_scope
|
Scope of the search; must be enclosed in quotation marks.
Valid Values: selected set, cellview, hierarchy, library
|
|
d_topCV
|
ID of the top-level cellview from which to start the hierarchical search. This argument is used only when t_scope is hierarchy.
|
|
t_viewNameList
|
A string of view names that specify the expansion of the hierarchy. This argument is used only when t_scope is hierarchy.
|
|
t_libName
|
Name of the library in which to search. This argument is used only when t_scope is library.
|
|
t_mode
|
Access mode used to open the cellviews found during the search; must be enclosed in quotation marks.
Valid Values: read, write
|
Value Returned
|
l_cvList
|
The list is a list of “writable” and “readable” cellviews. If t_mode is write, the system tries to get write access for each cellview found. If it can get write access, it puts the cellview in the writable list; otherwise, it puts it in the readable list. If t_mode is read, the system puts all the cellviews in the readable list.
|
|
nil
|
Returning the list was unsuccessful.
|
Examples
Returns a list of schematic cellviews that are in the hierarchy underneath the cellview top. The cellviews are placed in the readable list (second element).
cvId = dbOpenCellViewByType( "projectLib" "top" "schematic" "" 'r )
retList = schGetCellViewListInSearchScope( cvId "hierarchy" cvId "schematic symbol" "" "read" )
cvList = cadr( retList )
; use the cellviews in cvList here before freeing them
foreach( cvInfo cvList dbClose(cvInfo) )
Return to top
