The BYTE-LENGTH Function

Description:

The BYTE-LENGTH function returns an integer value that is the length in bytes of argument-1. The type of this function is integer.

General Format

FUNCTION BYTE-LENGTH (argument-1)

Arguments

1. Argument-1 can be a nonnumeric literal or a data item of any class or category.
2. If argument-1 or any data item subordinate to argument-1 is described with the DEPENDING phrase of the OCCURS clause, the contents of the data item referenced by the data-name specified in the DEPENDING phrase are used at the time the BYTE-LENGTH function is evaluated.

Returned values

1. If argument-1 is an alphanumeric literal or is an elementary data item of class other than national or is a group data item that does not contain a variable occurrence data item, the value returned is an integer equal to the length of argument-1 in alphanumeric character positions.
2. If argument-1 is a group data item containing a variable occurrence data item, the returned value is an integer determined by evaluation of the data item specified in the DEPENDING phrase of the OCCURS clause for that variable occurrence data item. This evaluation is accomplished according to the rules in the OCCURS clause dealing with the data item as a sending data item. See the section The OCCURS Clause in Data Division - File and Data Description.
3. The returned value includes implicit FILLER characters, if any.