UnicodeSubstring (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (align with revised syntax template) |
mNo edit summary |
||
| Line 15: | Line 15: | ||
<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>Pad</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| | <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 22: | Line 22: | ||
<li>The <var class="term">length</var> must be a non-negative number. A negative <var class="term">length</var> results in request cancellation. | <li>The <var class="term">length</var> must be a non-negative number. A negative <var class="term">length</var> results in request cancellation. | ||
<li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error. | <li>The <var class="term">pad</var> parameter must be either null or a single character. A longer value results in a compilation error. | ||
<li>If the <var class="term"> | <li>If the starting <var class="term">position</var> is known to be 1, it might be tidier and slightly more efficient to use the <var>UnicodeLeft</var> method instead of <var>UnicodeSubstring</var>. | ||
<li><var>UnicodeSubstring</var> method is analogous to the intrinsic <var>[[String class|String]]</var> method: <var>[[Substring (String function)|Substring]]</var>. | <li>The <var>UnicodeSubstring</var> method is analogous to the intrinsic <var>[[String class|String]]</var> method: <var>[[Substring (String function)|Substring]]</var>. | ||
<li><var>UnicodeSubstring</var> | <li><var>UnicodeSubstring</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.5. | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
<ol><li>The following statement places into %y the 5 characters of %x starting at the third character. If %x is shorter than 7 characters, then all of %x is copied into %y: | <ol><li>The following statement places into <code>%y</code> the 5 characters of <code>%x</code> starting at the third character. If <code>%x</code> is shorter than 7 characters, then all of <code>%x</code> is copied into <code>%y</code>: | ||
<p class="code">%y = %x:unicodeSubstring(3, 5) | <p class="code">%y = %x:unicodeSubstring(3, 5) | ||
</p> | </p> | ||
Revision as of 23:10, 28 February 2011
Return a substring of the method object string (Unicode class)
UnicodeSubstring returns a specific number of characters starting at a specific position in 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.
- The UnicodeSubstring method is analogous to the intrinsic String method: Substring.
- 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¡':U) printText {%u:unicodeSubstring(3,3, pad='!')}
The question mark in the result represents a valid EBCDIC character that is not displayable.