help

help( 
[ S_name ] 
) 
=> t / nil

Description

Retrieves and prints the cdsFinder documentation strings for the given function name (a symbol). If the given name is a string, it is interpreted as a regular expression, and the entire cdsFinder database is searched for functions whose name or documentation string contains or matches the given string. Help is an nlambda function.

Arguments

S_name

Name to search for.

Value Returned

t	The given function name is found in the cdsFinder.
nil	No match is found for S_name.

Examples

help nonexist

=> nil

help scanf

Prints the following and returns t.

fscanf( p_inputPort t_formatString [s_var1 ...]  )

scanf( t_formatString [s_var1 ...]  )

sscanf( t_sourceString t_formatString [s_var1 ...]  )

The only difference between these functions is the source of input. fscanf reads input from a port according to format specifications and returns the number of items read in. scanf takes its input from piport implicitly. scanf only works in standalone SKILL when the piport is not the CIW. sscanf reads its input from a string instead of a port.

=> t

help println

Prints the following and returns t.

println( g_value [p_outputPort] ) 
=> nil

Prints a SKILL object using the default format for the data type of the value, then prints a newline character.

=> t

help "read"

Prints the following and returns t.

fscanf, scanf, sscanf, getWarn, infile, instring, ipcReadProcess, ipcWaitForProcess, isReadable, lineread, linereadstring, load, loadstring, outfile, pp, putpropq, putpropqq, read, readTable, readstring

=> t

help "match nowhere"

=> nil

Related Topics

Core Functions

Return to top