printFunctions

printFunctions( 
t_pattern 
[ p_outport ] 
[ g_listAllFuncs ] 
) 
=> t

Description

Prints all function names that contain the given substring or match the given regular expression.

These functions are useful for finding functions that contain the same substring or finding an individual function when you know only part of the name.

By default, the source of the returned values is the SKILL directory in the SKILL Finder database, which is located in the doc hierarchy under your_install_dir/doc/finder/SKILL. printFunctions will also look in the your_install_dir/local/finder/SKILL directory, as well as directories specified in CDS_FINDER_PATH for any personal functions you may have created and placed there in the appropriate SKILL Finder format. For usage of CDS_FINDER_PATH, seeEnvironment Variable for Additional Finder Data Directories.

If the third (optional) argument is specified to t, printFunctions looks at the SKILL virtual machine, rather than the cdsFinder database, and returns all isCallable Cadence public functions and user-defined SKILL functions that contain the given substring or match the given regular expression.

Arguments

t_pattern	Pattern to search for.
p_outport	Optional output port. Default is poport.
g_listAllFuncs	If specified to t, all isCallable Cadence public and user-defined function names that contain the given substring or match the given regular expression are returned. Default is nil.

Value Returned

t	Always returns t (after printing all the function names that contain the given substring or match the given regular expression).

Examples

Returns t and prints all the function names that contain the substring installDebug.

printFunctions( "installDebug" ) => t

Returns t and prints all isCallable Cadence public and user-defined function names that contain the substring x.

printFunctions( "x" nil t)

Returns t and writes all isCallable Cadence public and user-defined function names that contain the substring x to outfile.

p = outfile( "outfile" ) => port:"outfile"
printFunctions( "x" p t )

Related Topics

Debug Functions

listFunctions

printVariables

rexCompile

Return to top