Clara-Doc - Method Reference

CTBUFFLST_BuffLength
Description
Returns the size in bytes of the byte buffer located at a specified index within the list. If the buffer contains character data, this does not necessarily correspond to the length of the character string, for example, if the string is in UTF-8 or unicode; some characters are more than one byte in size.

Prototype 

			
     DCTBUFFLST_BuffLength...
     D                 PR            10I 0
     D@This                            *   Value
     D@Index                         10I 0 Value
Parameters
@This
TypePointer (*)
Passing ModeValue
DescriptionThe address of an CTBUFFLST instance. This pointer MUST be obtained through a call to CTBUFFLST_Constructor.
@Index
Type10I 0
Passing ModeValue
DescriptionThe index of a buffer within the list. The first buffer is at index 1.
Return Values


Returns the size in bytes of the byte buffer located at a specified index within the list.