Clara-Doc - Method Reference
CTBUFFLST_GetBuffer
Description
Returns a byte buffer from the CTBUFFLST instance at a specified index location in a supplied CTBUFF instance.
Prototype
DCTBUFFLST_GetBuffer...
D PR 10I 0
D@This * Value
D@StrObj * Value
D@Index 10I 0 Value
Parameters
@This
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of an CTBUFFLST instance. This pointer MUST be obtained through a call to CTBUFFLST_Constructor. |
@StrObj
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a CTBUFF instance provided by the caller. The caller must have called the CTBUFF_Constructor method on the @StrObj parameter before calling this method. The requested byte buffer will be copied to the CTBUFF instance. |
@Index
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The index position of the byte buffer within the CTBUFFLST instance. The first byte buffer in the list is located at index 1. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The byte buffer has been successfully copied to the CTBUFF instance. |
| CS_FAILURE | 1 | The byte buffer has not been copied. This could be due to an invalid index (out of range) or if the @StrObj pointer is *null. |