DC@F48 - Built-In Function Argument/Return Value Definition

File Name:

DC@F48

Description:

Built-In Functions Definition file.

Normal Library:

<<pgmlib>>

 

Logical Views

Name Use Keys/Description/Comments

DC@F48V1

Read

F48BIF, F48AOR, F48SEQ (unique).

DC@F48V2

Update

Same as DC@F48V1.

DC@F48V3

Read

F48BIF, F48PNO (unique).

DC@F48V4

Update

Same as DC@F48V3.

 

 

Record Layout

Field Name Type Len Dec Description / Comments / Values

F48BIF

A

20

 

Built-In Function name. This is exactly the same name that is used to define the Built-In Function in file DC@F47.

F48AOR

A

3

 

RET or ARG. Specifies whether this parameter is an argument or return value. Arguments are identified with the value ARG, and return values are identified with the value RET.

F48SEQ

P

3

0

The sequence of this argument or return value in relation to the other arguments or return values.

F48PNO

P

3

0

Sequence as a CALL parm. The relative number of this argument or return value. For example, the 2nd return value could be the 8th parameter, so it should be number 8.

F48IDN

A

1

 

A unique identifier number/character for the argument or return value. Acceptable values are A - Z, 0 - 9. The first parameter would be identified as A, the second as B, etc.

F48DES

A

40

 

A brief description of this argument or return value in up to 40 characters.
If the argument or return value is a field, its description.
If the argument or return value is a working list, the description of its counter field if it exists.

F48ROO

A

1

 

R (Required) or O (Optional).
R specifies that an argument or return value is required (i.e. must be specified).
O indicates optional (i.e. can be left out). A default value must be specified for an Optional argument.

R if the argument or return value is a
-  working list
- a field without a default value.

O if the argument or return value is a field with a default value.

Note: A Required value cannot follow an Optional value.

F48TYP

A

1

 

Parameter Type

A (Alpha), N (Numeric) or L (List). This parameter is used to determine the type of this argument or return value.
A if the argument or return value is a field of type *CHAR.
N if argument or return value is a field of type *DEC.
L if argument or return value is a working list. When L is specified, the argument or return value used in the LANSA function must have been a working List. To use a list (L) as an argument or a return value, you must call an external routine (type C). Use of lists with internal routines is not supported.
N if argument or return value is a field of type REFFIELD to a signed field.

Note for Built-In Function for Windows:

Alpha, Char and String are all classed as String types and are valid arguments of type 'A'.

Packed, Signed, Float and Integer are classed as Numbers and so are valid for arguments of type 'N'.

All other types like Date, Datetime, BLOB and CLOB are classed as there own type and thus are not valid for either a type 'A', or type 'N'. To use these field types they must be coerced into a field type that is valid for the argument type. E.g. a Datetime can be coerced into a Char field in order to be passed as an argument of type 'A'.

There is also type 'X', which means any LANSA field type, including Datetime, etc.

 

F48MLN

P

11*

0

The minimum acceptable length of the field being passed from the LANSA function to the Built-In Function.

1 if the argument or return value is a field.

F48XLN

P

11*

0

The maximum acceptable length of the field being passed from the LANSA function to the Built-In Function.

Field length if the argument or return value is a field.

Note for Built-In Function for Windows:

Arguments and return values can be defined with a new maximum length value of 2147483647, meaning unlimited. This will mean there is no need to check the min/max field length.

Some N or X arguments and return values will be defined with a new maximum decimals value of 32767, meaning unlimited. This will mean there is no need to check the min/max decimals length.

 

F48MDP

P

5*

0

The minimum acceptable number of decimals that the field being passed from the LANSA function to the Built-In Function can contain.
0 if the argument or return value is a working list.
0 if the argument or return value is a field of type *CHAR.
0 if the argument or return value is a field with decimal places less than length.
1 if the argument or return value is a field with decimal places equal to length.

F48XDP

P

5*

0

The maximum acceptable number of decimals that the field being passed from the LANSA function to the Built-In Function can contain.
0 if the argument or return value is a working list.
0 if the argument or return value is a field of type *CHAR.
# of decimal places if the argument or return value is a field.

F48PLN

P

11*

0

Pass Length:
the length that the argument or return value will be passed/returned to/from the Built-In Function.
Field length if the argument or return value is a field.

F48PDP

P

5*

0

The number of decimals that the argument or return value will be passed/returned to/from the Built-In Function.
0 if the argument or return value is a working list.
0 if the argument or return value is a field of type *CHAR.
# of decimal places if the argument or return value is a field.

F48DFT

A

10

 

Default value.
The value to be given to this argument if one is not specified. The value can only be a numeric literal (e.g. 2, 3, 4), an alphanumeric literal in quotes (e.g.: 'A', 'IBM') or *BLANKS.
*BLANK if the argument or return value is a working list.
Default value if the argument or return value is a field.

Note: This parameter only applies to arguments.

 

 

*Note: The increased length of the various fields on this file apply from LANSA V11.0 only.