Clara-Doc - Method Reference
CTBUFF_Comp
Description
Compares the CTBUFF instance with a buffer zone . The method performs a byte per byte copy. This is why a comparison with another CTBUFF will not return reliable results since the instance's value will be compared against the implementation of the CTBUFF against which it is being compared. When comparing two CTBUFF instances, use the CTBUFF_BuffComp method.
Prototype
DCTBUFF_Comp...
D PR 10I 0
D@This * Value
D@Str * Value
D@Len 10I 0 Value
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 holds the comparison pattern against which the CTBUFF value will be compared. |
@Len
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The length in bytes of the comaprison patter. If the comparison pattern is a character string, then the actual pattern length may be greater than the string length (if the string is UTF-8 for instance). Make sure you specify the length in bytes, not the length in characters. |
Return Values
| Symbolic Constant | Value | Description |
| N/A | 1 | The values of the buffer in @This is greater than the value of the buffer pointed to by @Buff |
| N/A | 0 | The values of the buffer in @This is greater than the value of the buffer pointed to by @Buff |
| N/A | -1 | The values of the buffer in @This is lower than the value of the buffer pointed to by @Buff |