UnicodeChar (Unicode function): Difference between revisions

Revision as of 03:34, 19 January 2011

Single character at specified position of string

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

The UnicodeChar function is available as of version 7.5 of the Sirius Mods.

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

The position value must be a non-negative, non-zero number; a zero or negative number results in request cancellation. A length 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 the UnicodeSubstring function with a length argument of 1.
The UnicodeChar method is analogous to the intrinsic String Char function.

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.

For further information about the above request, see descriptions of:

@@ Line 10: / Line 10: @@
 The UnicodeChar function is available as of version 7.5  of the ''Sirius Mods''.
-===Syntax===
+==Syntax==
-   %outUni = unicode:UnicodeChar(position)
+{{Template:: syntax}}
-====Syntax Terms====
+===Syntax terms===
 <dl>
 <dt><i>%outUni</i>
@@ Line 24: / Line 24: @@
 </dl>
-===Usage Notes===
+==Usage notes==
 <ul>
 <li>The ''position'' value must be a non-negative, non-zero number;