[ Previous | Next | Contents | Search ]
3270 Host Connection Program 2.1 and 1.3.3 for AIX: Guide and Reference

FIND FIELD LENGTH (32)

Purpose

Returns the length of a target field in the connected Presentation Space (PS).

Prerequisite Calls

This function requires a prerequisite call to the CONNECT PRESENTATION SPACE (1) function.

Syntax

hllc (func, apistring, len, ret)
int *func;
char *apistring;
int *len;
int *ret;

Supplied Parameters

Supply the following parameters to invoke the FIND FIELD LENGTH function:

func Specifies the number of the function called; must be 32 for the FIND FIELD LENGTH function.
apistring Specifies the attributes of the API string; the calling two-character data string can contain:
Option Description
bb or Tb Specifies this field.
Pb Specifies the previous field, either protected or unprotected.
Nb Specifies the next field, either protected or unprotected.
NP Specifies the next protected field.
NU Specifies the next unprotected field.
PP Specifies the previous protected field.
PU Specifies the previous unprotected field.
Note: The b symbol represents a required blank.
len Does not apply for this function (length of 2 is implied).
ret Identifies the field within the host PS where the find begins. This parameter can be the PS position of any byte within the field in that you want the FIND FIELD LENGTH function to start.

Returned Parameters

len The following fields are valid:
=0 Specifies field length of 0 if return code=28 or the unformatted host PS if return code=24.
>0 Specifies length of requested field in host PS.
ret The following codes are valid:
0 Indicates the FIND FIELD LENGTH function was successful.
1 Specifies that your program was not connected to the host session.
2 Indicates a parameter error occurred.
7 Indicates the host PS position was invalid.
9 Indicates a system error occurred.
24 Indicates that no such field was found, or that PS is unformatted.
28 Indicates the field length was 0 bytes.

Remarks

The FIND FIELD LENGTH function returns the number of characters contained in the requested field. The requested field includes all characters from the beginning of the target field up to the character preceding the next attribute byte.

Related Information

CONNECT PRESENTATION SPACE (1) function and FIND FIELD POSITION function.


[ Previous | Next | Contents | Search ]