Method Utf8ToUcs
Utf8ToUcs(out Rune, byte*, ref int, int)
Reads a UTF-8 encoded character from a buffer.
Declaration
public static ConversionError Utf8ToUcs(out Unicode.Rune rune, byte* buffer, ref int index, int capacity)Parameters
| Type | Name | Description |
|---|---|---|
| Unicode.Rune | rune | Outputs the character read. If the read fails, outputs ReplacementCharacter. |
| byte* | buffer | The buffer of bytes to read. |
| int | index | Reference to a byte index into the buffer. If the read succeeds, index is incremented by the size in bytes of the character read. If the read fails, index is incremented by 1. |
| int | capacity | The size in bytes of the buffer. Used to check that the read is in bounds. |
Returns
| Type | Description |
|---|---|
| ConversionError | None if the read succeeds. Otherwise, returns Overflow or Encoding. |