Clara-Doc - Method Reference

CTBUFFLST_InsertValue
Description
Inserts a byte buffer in the list from a user-supplied buffer. Do NOT use a CTBUFF instance (unless you mean to insert a byte-per-byte image of a CTBUFF instance).

Prototype

			
     DCTBUFFLST_InsertValue...
     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
DescriptionThe 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 unless you wish to copy its byte-per-byte image. 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 of the requested byte buffer within the CTBUFFLST instance. The first byte buffer is located at index 1.
Return Values