Clara-Doc - Method Reference
CTBUFF_ByteAt
Description
Returns the integer value of the byte located at the specified index within the buffer.
Prototype
DCTBUFF_ByteAt...
D PR 3U 0
D@This * Value
D@Index 10I 0 Value
Parameters
@This
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | Pointer to a CTBUFF instance obtained via the CTBUFF_Constructor method. |
@Index
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The index value of the character to retrieve. Index values are 1-based (first character is at position 1). |
Return Values
The method returns a value from 0 to 255. If the index value is out of range, the return value is set at 255. If the buffer contains a character string in EBCDIC, then the return value is the EBCDIC character. This might not however be a valid character for ALPHA fields. It is important not to confuse ALPHA fields and buffers, which can hold binary data such as sounds and pictures.