Clara-Doc - Method Reference
CTBUFF_Get
Description
Retrieves a portion (or all) of the CTBUFF value.
Prototype
DCTBUFF_Get...
D PR 10I 0
D@This * Value
D@Str * Value
D@From 10I 0 Value
D@Len 10I 0
Parameters
@This
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of an CTBUFF instance. This pointer MUST be obtained through a call to CTBUFF_Constructor. |
@Str
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a buffer that will receive the CTBUFF instance value (or portion of). |
@From
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The starting position within the CTBUFF instance from which to copy the value into the out buffer. The first position starts at 1. |
@Len
| Type | 10I 0 |
| Passing Mode | By Reference |
| Description | The number of bytes to copy into the out buffer. The actual number of bytes will never exceed the size of the CTBUFF instance value regardless of this parameter value. Specify -1 to copy up to the end of the CTBUFF instance value. Make sure the out buffer is large enough to hold the requested byte string (especially if the instance holds a multi-byte character string). |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The extraction succeeded. |
| CS_FAILURE | 1 | The extraction failed. |