$StrOr: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
Line 15: Line 15:


==Syntax==
==Syntax==
<p class="syntax"><span class="term">%STR</span> = <span class="literal">$StrOr</span>(<span class="term">string1</span>, <span class="term">string2</span>, <span class="term">pad</span>)
<p class="syntax"><span class="term">%STR</span> = <span class="literal">$StrOr</span>(<span class="term">string1</span>, <span class="term">string2</span>, [<span class="term">pad</span>])
</p>
</p>
<p>
<p>
</p>
</p>


<p>%STR is the bit-wise OR of '''string1''' and '''string2'''.</p>
<p>%STR is the bit-wise OR of ''string1'' and ''string2''.</p>
For example
For example



Revision as of 02:11, 16 April 2013

Bit-wise OR two strings

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StrOr function is the BitOrString (String function).

This function performs a bit-wise OR of two strings.

The $StrOr function accepts three arguments and returns a string result that is the bit-wise OR of the first two arguments, the shorter being padded with as many copies of the third argument as are required to make the string lengths equal.

The first argument is an arbitrary string.

The second argument is another arbitrary string.

The third argument is another arbitrary string that is appended to the shorter of the first two strings and replicated as many times as required to make the strings of equal length. If this value is not specified or is null it defaults to a single null byte (X'00').

Syntax

%STR = $StrOr(string1, string2, [pad])

%STR is the bit-wise OR of string1 and string2.

For example

%X = $X2C('112233445566') %Y = $X2C('654321') %JUNK = $StrOr(%X, %Y)

would set %JUNK to X'756333445566' and

%X = $X2C('112233445566') %JUNK = $StrOr(%X, , $X2C('CC'))

would set %JUNK to X'DDEEFFCCDDEE' and

%X = $X2C('112233445566') %Y = $X2C('1122') %Z = $X2C('FF00') %JUNK = $StrOr(%X, %Y, %Z)

would set %JUNK to X'1122FF44FF66'.

$StrOr is only available in Sirius Mods Version 6.2 and later.

Products authorizing $StrOr