UnicodeSubstring (Unicode function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (syntax terms, tags and links)
Line 1: Line 1:
{{Template:Unicode:UnicodeSubstring subtitle}}
{{Template:Unicode:UnicodeSubstring subtitle}}


This function returns a specific number of characters starting at a
<var>UnicodeSubstring</var> returns a specific number of characters starting at a specific position in the method object <var>Unicode</var> string, possibly padding it on the right.
specific position in the method object <var>Unicode</var> string,
possibly padding it on the right.


The <var>UnicodeSubstring</var> function is available as of version 7.5  of the <var class=product>Sirius Mods</var>.
==Syntax==
==Syntax==
{{Template:Unicode:UnicodeSubstring syntax}}
{{Template:Unicode:UnicodeSubstring syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outUni</th>
<tr><th>%outUnicode</th>
<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeSubstring</var> method. </td></tr>
<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeSubstring</var> method. </td></tr>
<tr><th>unicode</th>
<tr><th>unicode</th>
Line 17: Line 14:
<td>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 <tt>1</tt>. </td></tr>
<td>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 <tt>1</tt>. </td></tr>
<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 start position), it is either padded to the requested length, or the entire method object starting at the start position is returned with no padding, depending on the value of the pad 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">start</var> position), it is either padded to the requested length, or the entire method object starting at the <var class="term">start</var> position is returned with no padding, depending on the value of the <var class="term">pad</var> parameter. </td></tr>
<tr><th>Pad=char</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. ''char'' defaults to a null, which means no padding is done. Pad is a name-required 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|Name-Required]]</var> parameter.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The length must be a non-negative number.
<li>The <var class="term">length</var> must be a non-negative number. A negative <var class="term">length</var> results in request cancellation.
A negative number 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 pad parameter must be either null or a single character.
<li>If the <var class="term">start</var> position 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>.
A longer value results in a compilation error.
<li><var>UnicodeSubstring</var> method is analogous to the intrinsic <var>[[String class|String]]</var> method: <var>[[Substring (String function)|Substring]]</var>.
<li>If the starting position is known to be 1, it might be tidier and
<li><var>UnicodeSubstring</var> function is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.5.
slightly more efficient to use the <var>Unicode</var>Left method instead of <var>UnicodeSubstring</var>.
<li>The <var>UnicodeSubstring</var> method is analogous to
the <var>String</var> intrinsic [[Substring (String function)|Substring]] method.
</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:
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:
<p class="code">%y = %x:unicodeSubstring(3, 5)
<p class="code">%y = %x:unicodeSubstring(3, 5)
</p>
</p>
 
<li>The following statement displays <code>C?!</code>:
The following statement displays <tt>C?!</tt>:
<p class="code">%u is unicode initial('ABC&amp;#xA1;':[[U (String function)|U]])
<p class="code">%u is unicode initial('ABC&amp;#xA1;':U)
[[Intrinsic classes#printtext|printText]] {%u:unicodeSubstring(3,3, pad='!')}
[[Intrinsic classes#printtext|printText]] {%u:unicodeSubstring(3,3, pad='!')}
</p>
The question mark in the result represents a valid EBCDIC character that is not displayable.
</ol>


</p>
The question mark in the result represents a valid EBCDIC character that
is not displayable.
The U constant function used in the example is described ??[[U (String function)|U]].
For information about the PrintText statement, see the list
item [[??]] refid=intprnt..
==See also==
==See also==
{{Template:Unicode:UnicodeSubstring footer}}
{{Template:Unicode:UnicodeSubstring footer}}

Revision as of 04:55, 25 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.
start 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 start position), it is either padded to the requested length, or the entire method object starting at the start 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 Name-Required 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 start position is known to be 1, it might be tidier and slightly more efficient to use the UnicodeLeft method instead of UnicodeSubstring.
  • UnicodeSubstring method is analogous to the intrinsic String method: Substring.
  • UnicodeSubstring function is available as of "Sirius Mods" Version 7.5.

Examples

  1. 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:

    %y = %x:unicodeSubstring(3, 5)

  2. 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.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=UnicodeSubstring_(Unicode_function)&oldid=12120"