![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section contents
cdescriptor.oxh
this& =
NewDes&:(buffer&,length&,maxLength&)
Creates a descriptor object and returns a handle which allows the object to be manipulated.
buffer& |
The address of the buffer which this descriptor will represent. |
length& |
The used length of the buffer |
maxLength& |
The maximum size of the buffer |
this& |
An value which represents the created descriptor |
If the object could not be created then an error is generated
which should be trapped by an ONERR
handler.
LOCAL this&,length&,buffer& length& = 200 buffer& = ALLOC(length&) this& = NewDes&:(buffer&,0,length&) DeleteDes:(this&)
DeleteDes:(BYREF this&)
Destroys the descriptor object.
BYREF this& |
A handle to a descriptor |
LOCAL this&,length&,buffer& length& = 200 buffer& = ALLOC(length&) this& = NewDes&:(buffer&,0,length&) DeleteDes:(this&)
DesAppend:(this&, des&)
Appends the descriptor des&
onto the end of
the descriptor
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesAppendChar:(this&,char%)
Appends a character onto the end of the descriptor.
this& |
A handle to a descriptor |
char% |
Value of the character to append to the descriptor |
DesAppendFill:(this&,char%,length&)
Appends the character char%
, repeated length&
times, to the buffer. An error will be generated if this function
attempts to append more characters than will fit into the
descriptor's buffer.
this& |
A handle to a descriptor |
char% |
Value of the character to fill the descriptor |
length& |
The number of characters to fill. |
DesAppendJustify:(this&,des&,width&,align%,fill%)
The data in des&
is appended to the
descriptor this&
. The data is copied into a
field which is width%
characters wide and justified
according to the parameter align%
. Any remaining
space is filled with the character whose value is specified by
the fill%
parameter.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
width& |
The width of the field or the default width. |
align% |
The alignment type |
fill% |
The value of the character to fill unused space |
DesAppendJustifyStr:(this&,str$,width&,align%,fill%)
The data in str$
is appended to the descriptor this&
.
The data is copied into a field which is width%
characters wide and justified according to the parameter align%
.
Any remaining space is filled with the character whose value is
specified by the fill%
parameter.
this& |
A handle to a descriptor |
str$ |
The data to be copied |
width& |
The width of the field or the default width. |
align% |
The alignment type |
fill% |
The value of the character to fill unused space |
DesAppendNum:(this&,num&)
Converts the long integer value to a decimal character representation and appends it to the descriptor's buffer.
this& |
A handle to a descriptor |
num& |
A long integer value |
DesAppendNumFloat:(this&,num,format&)
The floating point value num
is converted to a
characters representation, using the conversion criteria
specified in the RealFormat object handle&
,
and appends it to the descriptor's buffer.
this& |
A handle to a descriptor |
num |
A floating point value to append |
format& |
A handle to a RealFormat object |
DesAppendRadix:(this&,num&,radix&)
Converts the long integer value, using as a base radix&
,
to a decimal character representation and appends it to the
descriptor's buffer. Any alphabetic characters in the resulting
number will be in lower case.
this& |
A handle to a descriptor |
num& |
A long integer value to append |
radix& |
The base used to convert the value |
DesAppendNumRadixUC:(this&,num&,radix&)
Converts the long integer value, using as a base radix&
,
to a decimal character representation and appends it to the
descriptor's buffer. Any alphabetic characters in the resulting
number will be upper case.
this& |
A handle to a descriptor |
num& |
A long integer value to append |
radix& |
The base used to convert the value |
DesAppendStr:(this&, str$)
Appends the string onto the end of the descriptor
this& |
A handle to a descriptor |
str$ |
The string to be appended |
value% =DesAt%:(this&,pos&)
This function returns a single character from the descriptors buffer.
this& |
A handle to a descriptor |
pos& | The position from which to extract the data from the descriptor. The value can range from 0 <= pos& < current length of the descriptor. |
value% |
The value of the character extracted. |
DesCapitalize:(this&)
Converts the first character in the descriptor to uppercase.
this& |
A handle to a descriptor |
DesCollate:(this&)
Removes the difference between characters that are deemed unimportant for the purpose of ordering characters into their collating sequence.
this& |
A handle to a descriptor |
result% = DesCompare%:(this&,des&)
Compares the contents of the descriptor this&
with the contents of the string str$
on a byte by
byte basis.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Positive, if this& is greater than des& .Zero, if this& and des&
have the same length and contentsNegative, if this& is less than des& |
result% = DesCompareC%:(this&,des&)
Compares the collated contents of the descriptors.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Positive, if this& is greater than des$ .Zero, if this& and des$
have the same length and contentsNegative, if this& is less than des$ |
result% = DesCompareF%:(this&,des&)
Compares the folded contents of the descriptors.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Positive, if this& is greater than des$ .Zero, if this& and des$
have the same length and contentsNegative, if this& is less than des$ |
result% = DesCompareStr%:(this&,str$)
Compares the contents of the descriptor this&
with the contents of the string str$
on a byte by
byte basis.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Positive, if this& is greater than str& .Zero, if this& and str&
have the same length and contentsNegative, if this& is less than str& |
result% = DesCompareStrC%:(this&,str$)
Compares the collated contents of the descriptors.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Positive, if this& is greater than str$ .Zero, if this& and str$
have the same length and contentsNegative, if this& is less than str$ |
result% = DesCompareStrF%:(this&,str$)
Compares the folded contents of the descriptors.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Positive, if this& is greater than str$ .Zero, if this& and str$
have the same length and contentsNegative, if this& is less than str$ |
DesCopy:(this&,des&)
The contents of the descriptor des&
is copied
into this&
descriptor replacing the existing
data in the descriptor. A error will be generated if the length
of des&
is greater then the maximum length of this&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesCopyC:(this&,des&)
The contents of the descriptor des&
is copied
into this&
descriptor replacing the existing
data in the descriptor. A error will be generated if the length
of des&
is greater then the maximum length of this&
.
The contents of des&
are collated before coping
them into this&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesCopyCP:(this&,des&)
The contents of the descriptor des&
is copied
into this&
descriptor replacing the existing
data in the descriptor. A error will be generated if the length
of des&
is greater then the maximum length of this&
.
The first character of des&
is converted to
uppercase and the remaining characters converted to lowercase
before coping them into this&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesCopyF:(this&,des&)
The contents of the descriptor des&
is copied
into this&
descriptor replacing the existing
data in the descriptor. A error will be generated if the length
of des&
is greater then the maximum length of this&
.
The contents of des&
are folded before coping
them into this&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesCopyLC:(this&,des&)
The contents of the descriptor des&
is copied
into this&
descriptor replacing the existing
data in the descriptor. A error will be generated if the length
of des&
is greater then the maximum length of this&
.
The contents of des&
are converted to lowercase
before coping them into this&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesCopyUC:(this&,des&)
The contents of the descriptor des&
is copied
into this&
descriptor replacing the existing
data in the descriptor. A error will be generated if the length
of des&
is greater then the maximum length of this&
.
The contents of des&
are converted to uppercase
before coping them into this&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesCopyStr:(this&,str$)
The contents of the string str$
is copied into this&
descriptor replacing the existing data in the descriptor. A error
will be generated if the length of str$
is greater
then the maximum length of this&
.
this& |
A handle to a descriptor |
str$ |
A string to copy into the descriptor's buffer |
DesCopyStrC:(this&,str$)
The contents of the string str$
is copied into this&
descriptor replacing the existing data in the descriptor. A error
will be generated if the length of str$
is greater
then the maximum length of this&
. The contents
of str$
are collated before coping them into this&
.
this& |
A handle to a descriptor |
str$ |
A string to copy into the descriptor's buffer |
DesCopyStrCP:(this&,str$)
The contents of the string str$
is copied into this&
descriptor replacing the existing data in the descriptor. A error
will be generated if the length of str$
is greater
then the maximum length of this&
. The first
character of str$
is converted to uppercase and the
remaining characters converted to lowercase before coping them
into this&
.
this& |
A handle to a descriptor |
str$ |
A string to copy into the descriptor's buffer |
DesCopyStrF:(this&,str$)
The contents of the string str$
is copied into this&
descriptor replacing the existing data in the descriptor. A error
will be generated if the length of str$
is greater
then the maximum length of this&
. The contents
of str$
are folded before coping them into this&
.
this& |
A handle to a descriptor |
str$ |
A string to copy into the descriptor's buffer |
DesCopyStrLC:(this&,str$)
The contents of the string str$
is copied into this&
descriptor replacing the existing data in the descriptor. A error
will be generated if the length of str$
is greater
then the maximum length of this&
. The contents
of str$
are converted to lowercase before coping
them into this&
.
this& |
A handle to a descriptor |
str$ |
A string to copy into the descriptor's buffer |
DesCopyStrUC:(this&,str$)
The contents of the string str$
is copied into this&
descriptor replacing the existing data in the descriptor. A error
will be generated if the length of str$
is greater
then the maximum length of this&
. The contents
of str$
are converted to uppercase before coping
them into this&
.
this& |
A handle to a descriptor |
str$ |
A string to copy into the descriptor's buffer |
DesDelete:(this&,pos&,length&)
Deletes data from the descriptor.
this& |
A handle to a descriptor |
pos& |
The position from which to start deletion of the data
from the descriptor. The value can range from 0 <= pos&
< current length of the descriptor. |
length& |
The number of bytes to extract. The value must not be negative or greater than the current length of the descriptor when added to pos& . |
result% = DesEQ%:(this&,des&)
Compares the descriptor this&
with the
descriptor des&
for equality.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Zero, if the descriptors are not equal Non-Zero, if the descriptors are equal |
DesCompare, DesCompareC, DesCompareF, DesGE, DesGT, DesLE, DesLT, DesNE
result% = DesEQStr%:(this&,str$)
Compares the descriptor this&
with the string
str$
for equality.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Zero, if the descriptors are not equal Non-Zero, if the descriptors are equal |
DesCompare, DesCompareC, DesCompareF, DesGE, DesGT, DesLE, DesLT, DesNE
DesFill:(this&,char%)
Fills every character in the descriptor's buffer with the
character char%
.
this& |
A handle to a descriptor |
char% |
A character value |
DesFillLen:(this&,char%,length&)
Fills the descriptor's buffer with the length&
characters char%
, starting at the beginning of the
buffer.
this& |
A handle to a descriptor |
char% |
A character value |
length& |
Length to be filled |
DesFillZ:(this&)
Fills the used part of the buffer with zeros. The used length of the buffer is left unchanged.
this& |
A handle to a descriptor |
DesFillZLen:(this&,length&)
The buffer is filled with length&
characters
whose value is zero. The current udes length is set to length&
.
this& |
A handle to a descriptor |
length& |
Length of buffer to set to zero |
pos& = DesFind&:(this&,des&)
Searches the descriptor this&
for the
location which matches the contents of the descriptor des&
.
Note that if the length of des&
is zero then
the value 0 will be returned.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the
descriptor des& was found, or -1 if it
was not found |
pos& = DesFindC&:(this&,des&)
Searches the descriptor this&
for the
location which matches the contents of the descriptor des&
.
The contents of this& and des& are collated during the
matching process.
Note that if the length of des&
is zero then
the value 0 will be returned.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the
descriptor des& was found, or -1 if it
was not found |
pos& = DesFindF&:(this&,des&)
Searches the descriptor this&
for the
location which matches the contents of the descriptor des&
.
The contents of this& and des& are folded during the
matching process.
Note that if the length of des&
is zero then
the value 0 will be returned.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the
descriptor des& was found, or -1 if it
was not found |
pos& = DesFindStr&:(this&,str$)
Searches the descriptor this&
for the
location which matches the contents of the string str$
.
Note that if the length of str$
is zero then the
value 0 will be returned.
this& |
A handle to a descriptor |
str$ |
A string to find |
pos& |
The offset into the descriptor's buffer where the string was found, or -1 if it was not found |
pos& = DesFindStrC&:(this&,str$)
Searches the descriptor this&
for the
location which matches the contents of the string str$
.
The contents of this& and str$ are collated during the
matching process.
Note that if the length of des&
is zero then
the value 0 will be returned.
this& |
A handle to a descriptor |
str$ |
A string to find |
pos& |
The offset into the descriptor's buffer where the string was found, or -1 if it was not found |
pos& = DesFindStrF&:(this&,str$)
Searches the descriptor this&
for the
location which matches the contents of the string str$
.
The contents of this& and str$ are folded during the matching
process.
Note that if the length of des&
is zero then
the value 0 will be returned.
this& |
A handle to a descriptor |
str$ |
A string to find |
pos& |
The offset into the descriptor's buffer where the string was found, or -1 if it was not found |
DesFold:(this&)
removes the difference between characters that are deemed unimportant for the purposes of inexact or case-insensitive matching. As well as ignoring difference in case, folding ignores any accent on a character.
this& |
A handle to a descriptor |
result% = DesGE%:(this&,des&)
Compares whether the descriptor this&
is
greater or equal to the descriptor des&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Zero, if this& < str$ Non-zero, if this& >= str$ |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGT, DesLE, DesLT, DesNE
result% = DesGEStr%:(this&,str$)
Compares whether the descriptor this&
is
greater or equal to the string str$
.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Zero, if this& < str$ Non-zero, if this& >= str$ |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGT, DesLE, DesLT, DesNE
result% = DesGT%:(this&,des&)
Compares whether the descriptor this&
is
greater the descriptor des&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Zero, if this& <= str$ Non-zero, if this& > str$ |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesLE, DesLT, DesNE
result% = DesGTStr%:(this&,str$)
Compares whether the descriptor this&
is
greater the string str$
.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Zero, if this& <= str$ Non-zero, if this& > str$ |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesLE, DesLT, DesNE
DesInsert:(this&,pos&,des&)
Inserts the contents of the descriptor des&
into the buffer of descriptor this&
at position pos&
.
this& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the
descriptor des& is inserted |
des& |
A handle to a descriptor |
DesInsertStr:(this&,pos&,str$)
Inserts the contents of the string str$
into the
buffer of descriptor this&
at position pos&
.
this& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the string is inserted |
str$ |
A string to insert |
DesJustify:(this&,des&,width&,align%,fill%)
The data in des&
is copied into the
descriptor this&
. The data is copied into a
field which is width%
characters wide and justified
according to the parameter align%
. Any remaining
space is filled with the character whose value is specified by
the fill%
parameter.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
width& |
The width of the field or the default width. |
align% |
The alignment type |
fill% |
The value of the character to fill unused space |
DesJustifyStr:(this&,str$,width&,align%,fill%)
The data in str$
is copied into the descriptor this&
.
The data is copied into a field which is width%
characters wide and justified according to the parameter align%
.
Any remaining space is filled with the character whose value is
specified by the fill%
parameter.
this& |
A handle to a descriptor |
str$ |
The data to be copied |
width& |
The width of the field or the default width. |
align% |
The alignment type |
fill% |
The value of the character to fill unused space |
result% = DesLE%:(this&,des&)
Compares whether the descriptor this&
is less
than or equal to the descriptor des&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Zero, if this& > str$ Non-zero, if this& <= str$ |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesGT, DesLT, DesNE
str$ = DesLeft$:(this&,len&)
This function is used to extract the left len&
bytes
from the descriptor des&
.
this& |
A handle to a descriptor |
len& |
The number of bytes to extract. The value must not be
negative, greater than the current length of the
descriptor or exceed the value KMaxStringLen% . |
str$ |
The data extracted from the descriptor |
If the str$
string cannot be created then an
error is generated which should be trapped by an ONERR
handler.
length& = DesLength&:(this&)
This function returns the used part of the descriptor buffer.
this& |
A handle to a descriptor |
length& |
Length of the used part of the descriptor's buffer |
result% = DesLEStr%:(this&,str$)
Compares whether the descriptor this&
is less
than or equal to the string str$.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Zero, if this& > str$ Non-zero, if this& <= str$ |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesGT, DesLT, DesNE
pos& = DesLocate&:(this&,char%)
Searches the contents of the descriptor this&
for the first occurrence of the character char%
.
this& |
A handle to a descriptor |
char% |
The character to locate |
pos& |
The offset into the descriptor's buffer where the character was found, or -1 if it was not found. |
DesLocateF, DesLocateReverse, DesLocateReverseF
pos& = DesLocateF&:(this&,char%)
Searches the contents of the descriptor this&
for the first occurrence of the character char%
.after
they have been folded.
this& |
A handle to a descriptor |
char% |
The character to locate |
pos& |
The offset into the descriptor's buffer where the character was found, or -1 if it was not found. |
DesLocate, DesLocateReverse, DesLocateReverseF
pos& = DesLocateReverse&:(this&,char%)
Searches the contents of the descriptor this&
for the last occurrence of the character char%
.
this& |
A handle to a descriptor |
char% |
The character to locate |
pos& |
The offset into the descriptor's buffer where the character was found, or -1 if it was not found. |
DesLocate, DesLocateF, DesLocateReverseF
pos& = DesLocateReverseF&:(this&,char%)
Searches the contents of the descriptor this&
for the last occurrence of the character char%
.after
they have been folded.
this& |
A handle to a descriptor |
char% |
The character to locate |
pos& |
The offset into the descriptor's buffer where the character was found, or -1 if it was not found. |
DesLocate, DesLocateF, DesLocateReverse
DesLowerCase:(this&)
Converts the characters in the buffer to lowercase.
this& |
A value previously returned by NewDest |
result% = DesLT%:(this&,des&)
Compares whether the descriptor this&
is less
than the descriptor des&
.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Zero, if this& >= des& Non-zero, if this& < des& |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesGT, DesLE, DesNE
result% = DesLT%:(this&,str$)
Compares whether the descriptor this&
is less
than the descriptor des&
.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Zero, if this& >= des& Non-zero, if this& < des& |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesGT, DesLE, DesNE
pos& = DesMatch&:(this&,des&)
Compares the match pattern in the descriptor des&
with the contents of the descriptor this&
. If
the match pattern contains '*' it matches zero or more
characters. If the match pattern contains '?' it matches any
character.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the match was made, or -1 if it was not matched |
pos& = DesMatchC&:(this&,des&)
Compares the match pattern in the descriptor des&
with the contents of the descriptor this&
. If
the match pattern contains '*' it matches zero or more
characters. If the match pattern contains '?' it matches any
character. The contents of the buffers are collated for the
purposes of the matching process.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the match was made, or -1 if it was not matched |
pos& = DesMatchF&:(this&,des&)
Compares the match pattern in the descriptor des&
with the contents of the descriptor this&
. If
the match pattern contains '*' it matches zero or more
characters. If the match pattern contains '?' it matches any
character. The contents of the buffers are folded for the
purposes of the matching process.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
pos& |
The offset into the descriptor's buffer where the match was made, or -1 if it was not matched |
pos& = DesMatchStr&:(this&,str$)
Compares the match pattern in the string str$
with the contents of the descriptor this&
. If
the match pattern contains '*' it matches zero or more
characters. If the match pattern contains '?' it matches any
character.
this& |
A handle to a descriptor |
str$ |
A string to match |
pos& |
The offset into the descriptor's buffer where the match was made, or -1 if it was not matched |
pos& = DesMatchStrC&:(this&,str$)
Compares the match pattern in the string str$
with the contents of the descriptor this&
. If
the match pattern contains '*' it matches zero or more
characters. If the match pattern contains '?' it matches any
character. The contents of the buffers are collated for the
purposes of the matching process.
this& |
A handle to a descriptor |
str$ |
A string to match |
pos& |
The offset into the descriptor's buffer where the match was made, or -1 if it was not matched |
pos& = DesMatchStrF&:(this&,str$)
Compares the match pattern in the string str$
with the contents of the descriptor this&
. If
the match pattern contains '*' it matches zero or more
characters. If the match pattern contains '?' it matches any
character. The contents of the buffers are folded for the
purposes of the matching process.
this& |
A handle to a descriptor |
str$ |
A string to match |
pos& |
The offset into the descriptor's buffer where the match was made, or -1 if it was not matched |
length& = DesMaxLength&:(this&)
Returns the maximum length of data that the descriptor can hold in its buffer.
this& |
A handle to a descriptor |
length& |
The maximum length of the descriptor |
str$ = DesMid$:(this&,pos&,len&)
This function is used to extract len&
bytes
from the descriptor des&
starting at the
position pos&
.
this& |
A handle to a descriptor |
pos& |
The position from which to start extraction of the
data from the descriptor. The value can range from 0 <= pos& < current length of the descriptor. |
len& |
The number of bytes to extract. The value must not be negative, greater than the current length of the descriptor when added to pos&
or exceed the value KMaxStringLen% . |
str$ |
The data extracted from the descriptor |
If the str$
string cannot be created then an
error is generated which should be trapped by an ONERR
handler.
result% = DesNE%:(this&,des&)
Compares the descriptor this&
with the
descriptor des&
for inequality.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
result% |
Zero, if the descriptors are equal Non-Zero, if the descriptors are not equal |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesGT, DesLE, DesLT
result% = DesNEStr%:(this&,str$)
Compares the descriptor this&
with the string
str$
for inequality.
this& |
A handle to a descriptor |
str$ |
A string to compare |
result% |
Zero, if the descriptors are equal Non-Zero, if the descriptors are not equal |
DesCompare, DesCompareC, DesCompareF, DesEQ, DesGE, DesGT, DesLE, DesLT
DesNum:(this&,num&)
Converts the long integer value to a decimal character representation and copies it into the descriptor's buffer.
this& |
A handle to a descriptor |
num& |
A long integer value |
DesNumFloat:(this&,num,format&)
The floating point value num
is converted to a
characters representation, using the conversion criteria
specified in the RealFormat object handle&
,
and copies it into the descriptor's buffer.
this& |
A handle to a descriptor |
num |
A floating point value |
format& |
A handle to a RealFormat object |
DesNumRadix:(this&,num&,radix&)
Converts the long integer value, using as a base radix&
,
to a decimal character representation and copies it into the
descriptor's buffer. Any alphabetic characters in the resulting
number will be in lowercase.
this& |
A handle to a descriptor |
num& |
A long integer value |
radix& |
The base used to convert the value |
DesNumRadixUC:(this&,num&,radix&)
Converts the long integer value, using as a base radix&
,
to a decimal character representation and copies it into the
descriptor's buffer. Any alphabetic characters in the resulting
number will be in uppercase.
this& |
A handle to a descriptor |
num& |
A long integer value |
radix& |
The base used to convert the value |
DesRepeat:(this&,des&)
The descriptor des&
is repeatedly copied into
the descriptor this&
up to the current length of
the descriptor.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesRepeatStr:(this&,str$)
The string str$
is repeatedly copied into the
descriptor this&
up to the current length of the
descriptor.
this& |
A handle to a descriptor |
str$ |
A string to copy |
DesReplace:(this&,pos&,length&,des&)
Replaces length&
characters in the descriptor
this&
, starting at the offset pos&
,
with the contents of the descriptor des&
.
this& |
A handle to a descriptor |
pos& |
The position at which to start the replace |
length& |
The number of characters to replace |
des& |
A handle to a descriptor |
DesReplaceStr:(this&,pos&,length&,str$)
Replaces length&
characters in the descriptor
this&
, starting at the offset pos&
,
with the contents of the string str$
.
this& |
A handle to a descriptor |
pos& |
The position at which to start the replace |
length& |
The number of characters to replace |
str$ |
A string |
str$ = DesRight$:(this&,len&)
This function is used to extract the right len&
bytes
from the descriptor des&
.
this& |
A handle to a descriptor |
len& |
The number of bytes to extract. The value must not be
negative, greater than the current length of the
descriptor or exceed the value KMaxStringLen% . |
If the str$
string cannot be created then an
error is generated which should be trapped by an ONERR
handler.
str$ |
The data extracted from the descriptor |
DesSet:(this&,buffer&,length&,maxLength&)
(Re-)sets the buffer, current used length and maximum length of the descriptor.
this& |
A handle to a descriptor |
buffer& |
The address of the buffer which this descriptor will represent |
length& |
The used length of the buffer |
maxLength& |
The maximum size of the buffer |
DesSetLength:(this&,length&)
Sets the current length of the descriptor.
this& |
A handle to a descriptor |
length& |
The length to set |
DesSetMax:(this&)
Sets the length of the descriptor ot its maximum value
this& |
A handle to a descriptor |
str$ = DesStr$:(this&)
Returns the data in the descriptor's buffer.
Warning: This function must only be used on
descriptors whose used length is KMaxStringLen%
(256) or less in length.
this& |
A handle to a descriptor |
str$ |
The data extracted from the descriptor |
If the str$
string cannot be created then an
error is generated which should be trapped by an ONERR
handler.
DesSwap:(this&,des&)
Swaps the contents of the 2 descriptors.
this& |
A handle to a descriptor |
des& |
A handle to a descriptor |
DesTrim:(this&)
Deletes space characters from the start and end of the descriptor's buffer and reduces any remaining multiple spaces to single spaces.
this& |
A handle to a descriptor |
DesTrimAll:(this&)
Deletes space characters from the start and end of the descriptor's buffer.
this& |
A handle to a descriptor |
DesTrimLeft:(this&)
Deletes all the space characters at the start of the descriptor's buffer.
this& |
A handle to a descriptor |
DesTrimRight:(this&)
Deletes the space characters at the end of the descriptor's buffer.
this& |
A handle to a descriptor |
DesUpperCase:(this&)
Converts the contents of the buffer to uppercase.
this& |
A handle to a descriptor |
DesZero:(this&)
Sets the length of the descriptor to zero.
this& |
A handle to a descriptor |
DesZeroTerminate:(this&)
Writes a zero byte onto the end of the contents of the buffer. The current used length is unchanged.
this& |
A handle to a descriptor |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |