Update (CharacterToUnicodeMap subroutine): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:CharacterToUnicodeMap:Update subtitle}} | {{Template:CharacterToUnicodeMap:Update subtitle}} | ||
<var>Update</var> lets you add new, or change existing, mappings in a <var>CharacterToUnicodeMap</var> object. | |||
==Syntax== | ==Syntax== | ||
{{Template:CharacterToUnicodeMap:Update syntax}} | {{Template:CharacterToUnicodeMap:Update syntax}} | ||
| Line 7: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>characterToUnicodeMap</th> | <tr><th>characterToUnicodeMap</th> | ||
<td>CharacterToUnicodeMap object</td></tr> | <td>A <var>CharacterToUnicodeMap</var> object.</td></tr> | ||
<tr><th><var>In</var></th> | <tr><th><var>In</var></th> | ||
<td> | <td>A required, [[Notation conventions for methods#Named parameters|name required]], <var>String</var> or <var>Longstring</var> that specifies the single-byte character code points to be mapped to <var>Unicode</var> counterpart characters in the <var>Out</var> argument.</td></tr> | ||
<tr><th><var>Out</var></th> | <tr><th><var>Out</var></th> | ||
<td>Unicode</td></tr> | <td>An optional, name required, <var>Unicode</var> string, each of whose characters is mapped to the character in the <var>In</var> string that occupies the same relative position in the string. | ||
The <var>Out</var> string may not be longer than the <var>In</var>; it may be shorter, however, as long as a <var>Pad</var> character is specified. </td></tr> | |||
<tr><th><var>Pad</var></th> | <tr><th><var>Pad</var></th> | ||
<td>Unicode</td></tr> | <td>An optional, name required, <var>Unicode</var> string argument that specifies the character(s) used to pad the <var>Out</var> string on the right if it is shorter than <var>In</var>. </td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:CharacterToUnicodeMap:Update footer}} | {{Template:CharacterToUnicodeMap:Update footer}} | ||
Latest revision as of 01:55, 30 November 2011
Update this CharacterToUnicodeMap (CharacterToUnicodeMap class)
[Introduced in Sirius Mods 8.0]
Update lets you add new, or change existing, mappings in a CharacterToUnicodeMap object.
Syntax
characterToUnicodeMap:Update( In= string, [Out= unicode], [Pad= unicode])
Syntax terms
| characterToUnicodeMap | A CharacterToUnicodeMap object. |
|---|---|
| In | A required, name required, String or Longstring that specifies the single-byte character code points to be mapped to Unicode counterpart characters in the Out argument. |
| Out | An optional, name required, Unicode string, each of whose characters is mapped to the character in the In string that occupies the same relative position in the string. The Out string may not be longer than the In; it may be shorter, however, as long as a Pad character is specified. |
| Pad | An optional, name required, Unicode string argument that specifies the character(s) used to pad the Out string on the right if it is shorter than In. |