|
|
| (14 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| {{Template:String:BitOnString subtitle}}
| | #REDIRECT [[BitOnString and BitOrString (String functions)]] |
| | |
| <var>BitOnString</var> sets bits in one string as indicated by another.
| |
| | |
| ==Syntax==
| |
| {{Template:String:BitOnString syntax}}
| |
| ===Syntax terms===
| |
| <table class="syntaxTable">
| |
| <tr><th>%result</th><td>A string to receive the result of setting the bits in <var class="term">onBits</var> for <var class="term">string</var>.</td></tr>
| |
| <tr><th>string</th>
| |
| <td>The string to set bits in.</td></tr>
| |
| <tr><th>onBits</th>
| |
| <td>The bits to set.</td></tr>
| |
| <tr><th>Pad</th>
| |
| <td>A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of <var class="term">pad</var> 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 <var class="term">pad</var> is <code>'00':x</code>.</td></tr>
| |
| </table>
| |
| | |
| | |
| ==Usage notes==
| |
| <ul>
| |
| <li>Using a null <var class="term">string</var> or <var class="term">orBits</var> is an easy way of turning on a specific set of bits for each byte in a string (the <var class="term">pad</var> value).
| |
| <li><var>BitOnString</var> is most useful for working with binary data, for example binary data being sent or received with <var class="product">[[Janus Sockets]]</var>.
| |
| <li><var>BitOnString</var> was introduced in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> version 7.9.
| |
| </ul>
| |
| | |
| ==See also==
| |
| {{Template:String:BitOnString footer}}
| |