UnicodeChar (Unicode function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:Unicode:UnicodeChar subtitle}}
{{Template:Unicode:UnicodeChar subtitle}}


The <var>UnicodeChar</var> function returns the string value of the single character at a specified position in the method object <var>Unicode</var> string.
<var>UnicodeChar</var> returns the string value of the single character at a specified position in the method object <var>Unicode</var> string.


==Syntax==
==Syntax==
Line 18: Line 18:
<ul>
<ul>
<li>The <var class="term">position</var> value must be a non-negative, non-zero number; a zero or negative number results in request cancellation; a value greater than the declared length of the output string results in request cancellation.
<li>The <var class="term">position</var> value must be a non-negative, non-zero number; a zero or negative number results in request cancellation; a value greater than the declared length of the output string results in request cancellation.
<li>For a given <var class="term">position</var>, the <var class="term">UnicodeChar</var> function returns the same value as the <var>[[UnicodeSubstring (Unicode function)|UnicodeSubstring]]</var> function with a length argument of <code>1</code>.
<li>For a given <var class="term">position</var>, the <var>UnicodeChar</var> function returns the same value as <var>[[UnicodeSubstring (Unicode function)|UnicodeSubstring]]</var> with a length argument of <code>1</code>.
<li>The <var>UnicodeChar</var> method is analogous to the intrinsic <var>String</var> [[Char (String function)|Char]] function.
<li>The <var>UnicodeChar</var> method is analogous to the intrinsic <var>String</var> <var>[[Char (String function)|Char]]</var> function.
<li><var>UnicodeChar</var> is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.5.
<li><var>UnicodeChar</var> is available as of <var class="product">Sirius Mods</var> Version 7.5.
</ul>
</ul>


==Example==
==Example==
<ol>
The following request calls <var>UnicodeChar</var> two times:
<li>The following request calls <var>UnicodeChar</var> two times:
<p class="code">begin
<p class="code">begin
   [[PrintText statement|printText]] {'inaugural':unicodeChar(5)}
   [[PrintText statement|printText]] {'inaugural':unicodeChar(5)}
   %u is unicode initial('xyz&amp;#xA1;':U
   %u is unicode initial('xyz&amp;#xA1;':[[U (String function)|U]])
   printText {%u:unicodeChar(4)}
   printText {%u:unicodeChar(4)}
end
end
Line 39: Line 38:


The question mark in the result represents an EBCDIC character that is not displayable.
The question mark in the result represents an EBCDIC character that is not displayable.
</ol>


==See also==
==See also==
<ul>
<ul>
<li>the instrinsic <var>String</var> [[U (String function)|U]] function
<li><var>[[U (String function)]]</var>
</ul>
</ul>


{{Template:Unicode:UnicodeChar footer}}
{{Template:Unicode:UnicodeChar footer}}

Latest revision as of 17:04, 6 November 2012

The value at a specified position in the input string (Unicode class)


UnicodeChar returns the string value of the single character at a specified position in the method object Unicode string.

Syntax

%outUnicode = unicode:UnicodeChar( position)

Syntax terms

%outUnicode A Unicode variable to receive the result of the UnicodeChar method.
unicode A Unicode string.
position The position in the method object string, unicode, of the character you want to identify. A value of 1 finds the first character in the string.

Usage notes

  • The position value must be a non-negative, non-zero number; a zero or negative number results in request cancellation; a value greater than the declared length of the output string results in request cancellation.
  • For a given position, the UnicodeChar function returns the same value as UnicodeSubstring with a length argument of 1.
  • The UnicodeChar method is analogous to the intrinsic String Char function.
  • UnicodeChar is available as of Sirius Mods Version 7.5.

Example

The following request calls UnicodeChar two times:

begin printText {'inaugural':unicodeChar(5)} %u is unicode initial('xyz&#xA1;':U) printText {%u:unicodeChar(4)} end

The result is:

g ?

The question mark in the result represents an EBCDIC character that is not displayable.

See also