BitOnString and BitOrString (String functions): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Syntax terms) |
||
Line 7: | Line 7: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%result</th><td>A string to receive the result of | <tr><th>%result</th><td>A string to receive the result of combinining the bits in <var class="term">string</var> and <var class="term">orBits</var> as a result of the logical OR operation.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>One of the strings in the logical OR operation.</td></tr> | <td>One of the strings in the logical OR operation.</td></tr> |
Revision as of 21:13, 30 March 2012
Do bitwise Or of strings (String class) [introduced in Sirius Mods 7.9]
BitOrString does a logical OR of the bits in two strings.
Syntax
%result = string:BitOrString( orBits, [Pad= c])
Syntax terms
%result | A string to receive the result of combinining the bits in string and orBits as a result of the logical OR operation. |
---|---|
string | One of the strings in the logical OR operation. |
orBits | The other string in the logical OR operation. |
Pad | A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of pad are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of pad is '00':x . |
Usage notes
- Using a null string for orBits is an easy way of ORing each byte in a string with a specific byte value (the pad value).
- BitOrString is most useful for working with binary data, for example binary data being sent or received with Janus Sockets.
- BitOrString was introduced in Sirius Mods version 7.9.
Examples
The following example converts lowercase alphabetic characters to uppercase (because EBCDIC A-Z characters are equal to a-z characters plus X'40'):
%upper = %lower:bitOrString('', pad='40':x)
In, the above code, if %lower
were 'foobar'
, %upper
would be set to 'FOOBAR'
.