View source for ProtoFlux:String To UTF32

{{#Invoke:ProtoFlux|GenerateUI
|Name=String To UTF32
|Category=Characters
|Inputs=
[
{"Name": "String", "Type": "String"},
{"Name": "Index", "Type": "int"}
]
|Outputs=
[
{"Name": "*", "Type": "int"}
]
|}}

The '''String To UTF32''' returns the code point ([[UTF-32]] value) of a character or surrogate pair in a [[Type:string|string]].

== Inputs ==

=== String ([[Type:string|string]]) ===
The string to retrieve the character or surrogate pair from.

=== Index ([[Type:int|int]]) ===
The 0-indexed character to retrieve from <code>String</code>.

{{Warning:String Outside BMP}}

== Outputs ==

=== * ([[Type:int|int]]) ===
The code point of the character or surrogate pair at the index in the string.

The value <code>0</code> is returned instead if one of the following is true:

* <code>Index</code> is greater than or equal to the [[ProtoFlux:String Length|String Length]].
* <code>Index</code> points to a [https://en.wikipedia.org/wiki/Surrogate_code_points#Surrogates low surrogate].
* <code>Index</code> points to a high surrogate without a low surrogate following it.

== See Also ==
* [https://learn.microsoft.com/en-us/dotnet/api/system.char.converttoutf32#system-char-converttoutf32(system-string-system-int32) Microsoft documentation for the <code>Char.ConvertToUtf32(String, Int32)</code> method].

[[Category:ProtoFlux:Strings:Characters]]