peoplecodeapi - GetProgramFunctionInfo

Syntax

GetProgramFunctionInfo(ProgramId)

Where ProgramId is the following for PeopleCode user-defined functions:

RECORD.RecordName.FIELD.FieldName.METHOD.MethodName

Where ProgramId is the following for Component Interface user-defined methods:

COMPONENTINTERFACE.CIName.METHODS.Methods

Description

Use the GetProgramFunctionInfo function to determine the full signature and return values of a PeopleCode user-defined function, or a Component Interface method.

Parameters

Field or Control	Definition
`ProgramId`	Specify the full name of the function or the Component Interface method, as a string.

Returns

An array of array of any.

There is one array for every function or method defined in the program. Each array contains the following information:

The name of the function.
The signature of the parameters as a comma-separated string (see additional information below.)
The signature of the result (see result list below.)
The annotation of the Doc tag.
A boolean indicator of whether this function is to be exported (as indicated by the noexp tag).
A boolean indicator of whether this function is permitted to be called by this user. This only makes sense for Functions defined as CI methods in Component Interface PeopleCode. The default value is True.

The parameters may be modified by the following values:

Value	Description
?	An optional parameter.
*	A repeated parameter.
&	A parameter reference (PARM_NAME)

The possibly values of the result are as follows. Note the use of both lower and upper case letters.

Value	Description
D	Dec
d	Date
S	String
A	Any
B	Boolean
V	None
t	Time
T	DateTime
I	Image
i	Integer
O	Object
f	Float
9	Number
x	Unknown
[<value>	Array A single bracket indicates a single array. Two brackets indicates a two-dimensional array, three brackets a three-dimensional array, and so on. The value following the bracket indicates the type of array. For example, `[i` indicates an array of integer, `[[S` indicates an array of array of string.