UnicodeSubstring (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (see also) |
m (see also) |
||
| Line 14: | Line 14: | ||
<tr><th>length</th> | <tr><th>length</th> | ||
<td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var class="term">Pad</var> parameter. </td></tr> | <td>The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the <var class="term">position</var>), it is either padded to the requested <var class="term">length</var>, or the entire method object starting at the <var class="term">position</var> is returned with no padding, depending on the value of the <var class="term">Pad</var> parameter. </td></tr> | ||
<tr><th>Pad</th> | <tr><th><var>Pad</var></th> | ||
<td>The character used to pad the result string on the right if it is shorter than the requested length. <var class="term">Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var class="term">Pad</var> is a <var>[[Methods#Named parameters|NameRequired]]</var> parameter.</td></tr> | <td>The character used to pad the result string on the right if it is shorter than the requested length. <var class="term">Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var class="term">Pad</var> is a <var>[[Methods#Named parameters|NameRequired]]</var> parameter.</td></tr> | ||
</table> | </table> | ||
| Line 31: | Line 31: | ||
</p> | </p> | ||
<li>The following statement displays <code>C?!</code>: | <li>The following statement displays <code>C?!</code>: | ||
<p class="code">%u is unicode initial('ABC&#xA1;':[[U (String function)|U]]) | <p class="code">%u is unicode initial('ABC&amp;#xA1;':[[U (String function)|U]]) | ||
[[Intrinsic classes#printtext|printText]] {%u:unicodeSubstring(3,3, pad='!')} | [[Intrinsic classes#printtext|printText]] {%u:unicodeSubstring(3,3, pad='!')} | ||
</p> | </p> | ||
Revision as of 00:55, 13 April 2011
Return a substring of the method object string (Unicode class)
UnicodeSubstring returns a specific number of characters, starting at a specific position, from the method object Unicode string, possibly padding it on the right.
Syntax
%outUnicode = unicode:UnicodeSubstring( position, [length], [Pad= c])
Syntax terms
| %outUnicode | A Unicode variable to receive the result of the UnicodeSubstring method. |
|---|---|
| unicode | A Unicode string. |
| position | The character position in the method object that is the starting point of the substring that is returned. The first character from the left in the method object is position 1. |
| length | The number of characters to return. If the method object has fewer characters than the requested number of characters (starting at the position), it is either padded to the requested length, or the entire method object starting at the position is returned with no padding, depending on the value of the Pad parameter. |
| Pad | The character used to pad the result string on the right if it is shorter than the requested length. Pad defaults to the null string (''), which means no padding is done. Pad is a NameRequired parameter. |
Usage notes
- The length must be a non-negative number. A negative length results in request cancellation.
- The pad parameter must be either null or a single character. A longer value results in a compilation error.
- If the starting position is known to be 1, it might be tidier and slightly more efficient to use the UnicodeLeft method instead of UnicodeSubstring.
- UnicodeSubstring is available as of "Sirius Mods" Version 7.5.
Examples
- The following statement places into
%ythe 5 characters of%xstarting at the third character. If%xis shorter than 7 characters, then all of%xis copied into%y:%y = %x:unicodeSubstring(3, 5)
- The following statement displays
C?!:%u is unicode initial('ABC&#xA1;':U) printText {%u:unicodeSubstring(3,3, pad='!')}
The question mark in the result represents a valid EBCDIC character that is not displayable.