Update (CharacterMap subroutine): Difference between revisions
Jump to navigation
Jump to search
| Line 13: | Line 13: | ||
{{Template:CharacterMap:Update syntax}} | {{Template:CharacterMap:Update syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%map</th> | ||
< | <td>A CharacterMap object variable.</td></tr> | ||
< | <tr><th>In=string</th> | ||
< | <td>A required, name required, argument that specifies the "input table" characters that you are adding or resetting. | ||
characters that you are adding or resetting. | No character can be specified more than once in the In string, which may not be more than 256 characters.</td></tr> | ||
<tr><th>Out=string</th> | |||
No character can be specified more than once in the In string, which | <td>An optional, name required, argument that specifies the "output table" characters. | ||
may not be more than 256 characters. | The Out string may not be longer than the In string; it may be shorter, however, as long as a Pad character is specified. The Out string may not be more than 256 characters.</td></tr> | ||
< | <tr><th>Pad=char</th> | ||
< | <td>An optional, name required, argument that specifies the character used to pad the output table string on the right if it is shorter than the In string. | ||
characters. | |||
The Out string may not be longer than the In string; it may be shorter, however, | |||
as long as a Pad character is specified. | |||
The Out string may not be more than 256 characters. | |||
< | |||
< | |||
to pad the output table string on the right if it is shorter than the In string. | |||
''char'' must be a single character, only. | ''char'' must be a single character, only. | ||
</td></tr> | |||
</ | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
| Line 43: | Line 34: | ||
If an In string character you specify is not already mapped, the association | If an In string character you specify is not already mapped, the association | ||
indicated in the Update call is added to the method object's mapping. | indicated in the Update call is added to the method object's mapping. | ||
<li>If the In string is longer than the Out string, the | <li>If the In string is longer than the Out string, the "extra" In | ||
characters are associated with the Pad character. | characters are associated with the Pad character. | ||
In this case, it is a request-canceling error if no Pad character is present. | In this case, it is a request-canceling error if no Pad character is present. | ||
Revision as of 02:56, 16 January 2011
Update this CharacterMap (CharacterMap class)
Update is a member of the CharacterMap class.
The method lets you modify existing character associations or add new ones. The method's parameters and mapping rules are the same as the New method.
Syntax
characterMap:Update( In= string, [Out= string], [Pad= c])
Syntax terms
| %map | A CharacterMap object variable. |
|---|---|
| In=string | A required, name required, argument that specifies the "input table" characters that you are adding or resetting. No character can be specified more than once in the In string, which may not be more than 256 characters. |
| Out=string | An optional, name required, argument that specifies the "output table" characters. The Out string may not be longer than the In string; it may be shorter, however, as long as a Pad character is specified. The Out string may not be more than 256 characters. |
| Pad=char | An optional, name required, argument that specifies the character used to pad the output table string on the right if it is shorter than the In string.
char must be a single character, only. |
Usage notes
- Case is respected in all character specifications.
- If an In string character you specify is already mapped in the method object, the existing mapping is modified by the association indicated in the Update call. If an In string character you specify is not already mapped, the association indicated in the Update call is added to the method object's mapping.
- If the In string is longer than the Out string, the "extra" In characters are associated with the Pad character. In this case, it is a request-canceling error if no Pad character is present.
- The Out argument can be omitted, as long as a Pad argument is present. The Pad argument has no default.
- For an example of an Update call, see the CharacterMap class page.