New (CharacterMap constructor): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 3: | Line 3: | ||
</p> | </p> | ||
The New method creates a character map, which associates individual | The <var>New</var> method creates a character map, which associates individual | ||
characters from an In string (the "input table") with the characters | characters from an In string (the "input table") with the characters | ||
in the corresponding position in the "output table". | in the corresponding position in the "output table". | ||
| Line 13: | Line 13: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%characterMap</th> | <tr><th>%characterMap</th> | ||
<td>A CharacterMap object variable.</td></tr> | <td>A <var>CharacterMap</var> object variable.</td></tr> | ||
<tr><th>in</th> | <tr><th>in</th> | ||
<td>A required, name required, argument that specifies the "input table" characters in the mapping. | <td>A required, name required, argument that specifies the "input table" characters in the mapping. | ||
| Line 34: | Line 34: | ||
<li>The Out argument can be omitted, as long as a Pad argument is present. | <li>The Out argument can be omitted, as long as a Pad argument is present. | ||
The Pad argument has no default. | The Pad argument has no default. | ||
<li>For an example of a New method call, see the [[CharacterMap class#Example|CharacterMap class]] page. | <li>For an example of a <var>New</var> method call, see the [[CharacterMap class#Example|CharacterMap class]] page. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:CharacterMap:New footer}} | {{Template:CharacterMap:New footer}} | ||
Revision as of 21:45, 6 February 2011
Create CharacterMap object (CharacterMap class)
The New method creates a character map, which associates individual characters from an In string (the "input table") with the characters in the corresponding position in the "output table". The output table consists of the characters in the Out string (plus copies of the Pad character, if necessary).
Syntax
%characterMap = [%(CharacterMap):]New( In= string, [Out= string], [Pad= c])
Syntax terms
| %characterMap | A CharacterMap object variable. |
|---|---|
| in | A required, name required, argument that specifies the "input table" characters in the mapping. No character duplications are allowed in the In string, which may not be more than 256 characters. |
| out | An optional, name required, argument that specifies the "output table" characters. out may not be longer than in; it may be shorter, however, as long as a pad character is specified. out may not be more than 256 characters. |
| pad | An optional, name required, argument that specifies the character used to pad the output table string on the right if it is shorter than in.
pad must be a single character, only. |
Usage notes
- Case is respected in all character specifications.
- 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 a New method call, see the CharacterMap class page.