Clara-Doc - Method Reference

CTBUFFLST_SetValue
Description
Sets a byte buffer within the list at a specified location from a caller-supplied buffer.

Prototype 

			
     DCTBUFFLST_SetValue...
     D                 PR            10I 0
     D@This                            *   Value
     D@Str                             *   Value
     D@Len                           10I 0 Value
     D@Index                         10I 0 Value
Parameters
@This
TypePointer (*)
Passing ModeValue
Description The address of an CTBUFFLST instance. This pointer MUST be obtained through a call to CTBUFFLST_Constructor.
@Str
TypePointer (*)
Passing ModeValue
DescriptionThe address of a user-supplied buffer. Don't use a CTBUFF instance. The user-supplied buffer can be a local variable of any type or a buffer resulting from a call to %Alloc.
@Len
Type10I 0
Passing ModeValue
DescriptionThe size in bytes of the buffer pointed to by the @Str parameter.
@Index
Type10I 0
Passing ModeValue
DescriptionThe 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 ConstantValueDescription
CS_SUCCESS0The byte buffer has been updated successfully.
CS_FAILURE1The byte buffer has not been updated. This could be due to an index out of range or a *null pointer is passed in the @Str parameter.