Clara-Doc - Method Reference
CTBUFFLST_SetBuffer
Description
Prototype
DCTBUFFLST_SetBuffer...
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 CTBUFF instance value will be used to set the byte buffer at the specified index in the list. |
@Index
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The index location within the list of the byte buffer to update. DO NOT specify CTLST_BOTTOM or CTLST_TOP to get either the last or first buffer. The first byte buffer is at index 1. Use the actual index value. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The byte buffer has been updated successfully. |
| CS_FAILURE | 1 | The byte buffer has not been updated. This could be due to an index out of range or a *null CTBUFF instance passed in the @StrObj parameter. |