list / explain functions

Prev Next

Function Names

list functions, explain functions

Description

These functions lists provide information about the available functions

Call as: procedure

Restrictions

Indirect parameter passing is disabled

Parameter count

1

Parameters

No.TypeDescription
1
input
string Function name search string

The search string narrows down the name of the functions to be included in the listing. Wildcard symbols are supported here.

Examples

    define procedure( mode, {{ meaningful text, string }} )
    {
        echo("Test");
    }

    echo("Functions listed:");
    list functions( "mo*" ); // Lists 3 functions: mod, mode (defined here) and month.
    echo;
    echo("Functions explained:");
    explain functions( "mo*" );

Output

Functions listed:
Function Name                                       Call as     Parameters  
--------------------------------------------------  ----------  ------------
mod                                                 Function    2
mode                                                Procdure    1
month                                               Function    1

Functions explained:
Function Name                                       Call as     Parameters  
--------------------------------------------------  ----------  ------------
mod                                                 Function    2

     1: divisor                   Type: numeral or set (Numbers or set)
     2: dividend                  Type: numeral or set (Numbers or set)


mode                                                Procdure    1

     1: meaningful text           Type: string


month                                               Function    1

     1: date and/or time          Type: valid (Numeral, String, Boolean, Date, Set)


Try it yourself: Open LIB_Function_list_functions.b4p in B4P_Examples.zip. Decompress before use.

See also

dump functions
list variables
list tables