Char.ConvertToUtf32 Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Converts the value of a UTF-16 encoded surrogate pair into a Unicode code point.
Overloads
ConvertToUtf32(Char, Char) |
Converts the value of a UTF-16 encoded surrogate pair into a Unicode code point. |
ConvertToUtf32(String, Int32) |
Converts the value of a UTF-16 encoded character or surrogate pair at a specified position in a string into a Unicode code point. |
Examples
The following code example demonstrates the ConvertToUtf32 and ConvertFromUtf32 methods.
// This example demonstrates the Char.ConvertFromUtf32() method
// and Char.ConvertToUtf32() overloads.
using namespace System;
void Show( String^ s )
{
// Console::Write( "0x{0:X}, 0x{1:X}", (int)s->get_Chars( 0 ), (int)s->get_Chars( 1 ) );
Console::Write( "0x{0:X}, 0x{1:X}", (int)s[ 0 ], (int)s[ 1 ] );
}
int main()
{
int music = 0x1D161; //U+1D161 = MUSICAL SYMBOL SIXTEENTH NOTE
String^ s1;
String^ comment1a = "Create a UTF-16 encoded string from a code point.";
String^ comment1b = "Create a code point from a surrogate pair at a certain position in a string.";
String^ comment1c = "Create a code point from a high surrogate and a low surrogate code point.";
// -------------------------------------------------------------------
// Convert the code point U+1D161 to UTF-16. The UTF-16 equivalent of
// U+1D161 is a surrogate pair with hexadecimal values D834 and DD61.
Console::WriteLine( comment1a );
s1 = Char::ConvertFromUtf32( music );
Console::Write( " 1a) 0x{0:X} => ", music );
Show( s1 );
Console::WriteLine();
// Convert the surrogate pair in the string at index position
// zero to a code point.
Console::WriteLine( comment1b );
music = Char::ConvertToUtf32( s1, 0 );
Console::Write( " 1b) " );
Show( s1 );
Console::WriteLine( " => 0x{0:X}", music );
// Convert the high and low characters in the surrogate pair into a code point.
Console::WriteLine( comment1c );
music = Char::ConvertToUtf32( s1[ 0 ], s1[ 1 ] );
Console::Write( " 1c) " );
Show( s1 );
Console::WriteLine( " => 0x{0:X}", music );
}
/*
This example produces the following results:
Create a UTF-16 encoded string from a code point.
1a) 0x1D161 => 0xD834, 0xDD61
Create a code point from a surrogate pair at a certain position in a string.
1b) 0xD834, 0xDD61 => 0x1D161
Create a code point from a high surrogate and a low surrogate code point.
1c) 0xD834, 0xDD61 => 0x1D161
*/
// This example demonstrates the Char.ConvertFromUtf32() method
// and Char.ConvertToUtf32() overloads.
using System;
class Sample
{
public static void Main()
{
int letterA = 0x0041; //U+00041 = LATIN CAPITAL LETTER A
int music = 0x1D161; //U+1D161 = MUSICAL SYMBOL SIXTEENTH NOTE
string s1;
string comment = "Create a UTF-16 encoded string from a code point.";
string comment1b = "Create a code point from a UTF-16 encoded string.";
string comment2b = "Create a code point from a surrogate pair at a certain position in a string.";
string comment2c = "Create a code point from a high surrogate and a low surrogate code point.";
// Convert code point U+0041 to UTF-16. The UTF-16 equivalent of
// U+0041 is a Char with hexadecimal value 0041.
Console.WriteLine(comment);
s1 = Char.ConvertFromUtf32(letterA);
Console.Write(" 1a) 0x{0:X} => ", letterA);
Show(s1);
Console.WriteLine();
// Convert the lone UTF-16 character to a code point.
Console.WriteLine(comment1b);
letterA = Char.ConvertToUtf32(s1, 0);
Console.Write(" 1b) ");
Show(s1);
Console.WriteLine(" => 0x{0:X}", letterA);
Console.WriteLine();
// -------------------------------------------------------------------
// Convert the code point U+1D161 to UTF-16. The UTF-16 equivalent of
// U+1D161 is a surrogate pair with hexadecimal values D834 and DD61.
Console.WriteLine(comment);
s1 = Char.ConvertFromUtf32(music);
Console.Write(" 2a) 0x{0:X} => ", music);
Show(s1);
Console.WriteLine();
// Convert the surrogate pair in the string at index position
// zero to a code point.
Console.WriteLine(comment2b);
music = Char.ConvertToUtf32(s1, 0);
Console.Write(" 2b) ");
Show(s1);
Console.WriteLine(" => 0x{0:X}", music);
// Convert the high and low characters in the surrogate pair into a code point.
Console.WriteLine(comment2c);
music = Char.ConvertToUtf32(s1[0], s1[1]);
Console.Write(" 2c) ");
Show(s1);
Console.WriteLine(" => 0x{0:X}", music);
}
private static void Show(string s)
{
for (int x = 0; x < s.Length; x++)
{
Console.Write("0x{0:X}{1}",
(int)s[x],
((x == s.Length-1)? String.Empty : ", "));
}
}
}
/*
This example produces the following results:
Create a UTF-16 encoded string from a code point.
1a) 0x41 => 0x41
Create a code point from a UTF-16 encoded string.
1b) 0x41 => 0x41
Create a UTF-16 encoded string from a code point.
2a) 0x1D161 => 0xD834, 0xDD61
Create a code point from a surrogate pair at a certain position in a string.
2b) 0xD834, 0xDD61 => 0x1D161
Create a code point from a high surrogate and a low surrogate code point.
2c) 0xD834, 0xDD61 => 0x1D161
*/
open System
let show (s: string) =
for x = 0 to s.Length - 1 do
printf $"""0x{int s[x]:X}{if x = s.Length - 1 then String.Empty else ", "}"""
[<EntryPoint>]
let main _ =
let letterA = 0x0041 //U+00041 = LATIN CAPITAL LETTER A
let music = 0x1D161 //U+1D161 = MUSICAL SYMBOL SIXTEENTH NOTE
let comment = "Create a UTF-16 encoded string from a code point."
let comment1b = "Create a code point from a UTF-16 encoded string."
let comment2b = "Create a code point from a surrogate pair at a certain position in a string."
let comment2c = "Create a code point from a high surrogate and a low surrogate code point."
// Convert code point U+0041 to UTF-16. The UTF-16 equivalent of
// U+0041 is a Char with hexadecimal value 0041.
printfn $"{comment}"
let s1 = Char.ConvertFromUtf32 letterA
printf $" 1a) 0x{letterA:X} => "
show s1
printfn ""
// Convert the lone UTF-16 character to a code point.
printfn $"{comment1b}"
let letterA = Char.ConvertToUtf32(s1, 0)
printf " 1b) "
show s1
printfn $" => 0x{letterA:X}"
printfn ""
// -------------------------------------------------------------------
// Convert the code point U+1D161 to UTF-16. The UTF-16 equivalent of
// U+1D161 is a surrogate pair with hexadecimal values D834 and DD61.
printfn $"{comment}"
let s1 = Char.ConvertFromUtf32 music
printf $" 2a) 0x{music:X} => "
show s1
printfn ""
// Convert the surrogate pair in the string at index position
// zero to a code point.
printfn $"{comment2b}"
let music = Char.ConvertToUtf32(s1, 0)
printf " 2b) "
show s1
printfn $" => 0x{music:X}"
// Convert the high and low characters in the surrogate pair into a code point.
printfn $"{comment2c}"
let music = Char.ConvertToUtf32(s1[0], s1[1])
printf " 2c) "
show s1
printfn $" => 0x{music:X}"
0
// This example produces the following results:
//
// Create a UTF-16 encoded string from a code point.
// 1a) 0x41 => 0x41
// Create a code point from a UTF-16 encoded string.
// 1b) 0x41 => 0x41
//
// Create a UTF-16 encoded string from a code point.
// 2a) 0x1D161 => 0xD834, 0xDD61
// Create a code point from a surrogate pair at a certain position in a string.
// 2b) 0xD834, 0xDD61 => 0x1D161
// Create a code point from a high surrogate and a low surrogate code point.
// 2c) 0xD834, 0xDD61 => 0x1D161
Class Sample
Public Shared Sub Main()
Dim letterA As Integer = &H41 'U+00041 = LATIN CAPITAL LETTER A
Dim music As Integer = &H1D161 'U+1D161 = MUSICAL SYMBOL SIXTEENTH NOTE
Dim s1 As String
Dim comment As String = "Create a UTF-16 encoded string from a code point."
Dim comment1b As String = "Create a code point from a UTF-16 encoded string."
Dim comment2b As String = "Create a code point from a surrogate pair at a certain position in a string."
Dim comment2c As String = "Create a code point from a high surrogate and a low surrogate code point."
' Convert code point U+0041 to UTF-16. The UTF-16 equivalent of
' U+0041 is a Char with hexadecimal value 0041.
Console.WriteLine(comment)
s1 = [Char].ConvertFromUtf32(letterA)
Console.Write(" 1a) 0x{0:X} => ", letterA)
Show(s1)
Console.WriteLine()
' Convert the lone UTF-16 character to a code point.
Console.WriteLine(comment1b)
letterA = [Char].ConvertToUtf32(s1, 0)
Console.Write(" 1b) ")
Show(s1)
Console.WriteLine(" => 0x{0:X}", letterA)
Console.WriteLine()
' -------------------------------------------------------------------
' Convert the code point U+1D161 to UTF-16. The UTF-16 equivalent of
' U+1D161 is a surrogate pair with hexadecimal values D834 and DD61.
Console.WriteLine(comment)
s1 = [Char].ConvertFromUtf32(music)
Console.Write(" 2a) 0x{0:X} => ", music)
Show(s1)
Console.WriteLine()
' Convert the surrogate pair in the string at index position
' zero to a code point.
Console.WriteLine(comment2b)
music = [Char].ConvertToUtf32(s1, 0)
Console.Write(" 2b) ")
Show(s1)
Console.WriteLine(" => 0x{0:X}", music)
' Convert the high and low characters in the surrogate pair into a code point.
Console.WriteLine(comment2c)
music = [Char].ConvertToUtf32(s1.Chars(0), s1.Chars(1))
Console.Write(" 2c) ")
Show(s1)
Console.WriteLine(" => 0x{0:X}", music)
End Sub
Private Shared Sub Show(s As String)
Dim x As Integer
If s.Length = 0 Then Exit Sub
For x = 0 To s.Length - 1
Console.Write("0x{0:X}{1}", _
AscW(s.Chars(x)), _
IIf(x = s.Length - 1, [String].Empty, ", "))
Next
End Sub
End Class
'
'This example produces the following results:
'
'Create a UTF-16 encoded string from a code point.
' 1a) 0x41 => 0x41
'Create a code point from a UTF-16 encoded string.
' 1b) 0x41 => 0x41
'
'Create a UTF-16 encoded string from a code point.
' 2a) 0x1D161 => 0xD834, 0xDD61
'Create a code point from a surrogate pair at a certain position in a string.
' 2b) 0xD834, 0xDD61 => 0x1D161
'Create a code point from a high surrogate and a low surrogate code point.
' 2c) 0xD834, 0xDD61 => 0x1D161
'
ConvertToUtf32(Char, Char)
- Source:
- Char.cs
- Source:
- Char.cs
- Source:
- Char.cs
Converts the value of a UTF-16 encoded surrogate pair into a Unicode code point.
public:
static int ConvertToUtf32(char highSurrogate, char lowSurrogate);
public static int ConvertToUtf32 (char highSurrogate, char lowSurrogate);
static member ConvertToUtf32 : char * char -> int
Public Shared Function ConvertToUtf32 (highSurrogate As Char, lowSurrogate As Char) As Integer
Parameters
- highSurrogate
- Char
A high surrogate code unit (that is, a code unit ranging from U+D800 through U+DBFF).
- lowSurrogate
- Char
A low surrogate code unit (that is, a code unit ranging from U+DC00 through U+DFFF).
Returns
The 21-bit Unicode code point represented by the highSurrogate
and lowSurrogate
parameters.
Exceptions
highSurrogate
is not in the range U+D800 through U+DBFF, or lowSurrogate
is not in the range U+DC00 through U+DFFF.
Remarks
Use this method to convert a surrogate pair into a 21-bit Unicode code point. To convert UTF-16 data into UTF-32 data, use the System.Text.UTF32Encoding class.
Ordinarily, UTF-16 encoding represents a single Unicode character as a 16-bit code unit. However, it also supports surrogate pairs, which allow a single abstract character to be represented as two 16-bit code units. These two Char objects must have code units that range from U+D800 to U+DBFF for the first (high) surrogate and from U+DC00 to U+DFFF for the second (low) surrogate. Surrogate pairs are supported only by UTF-16 encoding. This method allows a character represented by a UTF-16 surrogate pair to be converted to a character using UTF-32 encoding.
See also
Applies to
ConvertToUtf32(String, Int32)
- Source:
- Char.cs
- Source:
- Char.cs
- Source:
- Char.cs
Converts the value of a UTF-16 encoded character or surrogate pair at a specified position in a string into a Unicode code point.
public:
static int ConvertToUtf32(System::String ^ s, int index);
public static int ConvertToUtf32 (string s, int index);
static member ConvertToUtf32 : string * int -> int
Public Shared Function ConvertToUtf32 (s As String, index As Integer) As Integer
Parameters
- s
- String
A string that contains a character or surrogate pair.
- index
- Int32
The index position of the character or surrogate pair in s
.
Returns
The 21-bit Unicode code point represented by the character or surrogate pair at the position in the s
parameter specified by the index
parameter.
Exceptions
s
is null
.
index
is not a position within s
.
The specified index position contains a surrogate pair, and either the first character in the pair is not a valid high surrogate or the second character in the pair is not a valid low surrogate.
Remarks
Use this method to convert a character or surrogate pair into a 21-bit Unicode code point. To convert UTF-16 data into UTF-32 data, use the System.Text.UTF32Encoding class.