TextEncoder.TryEncodeUnicodeScalar(Int32, Char*, Int32, Int32) Method

Definition

Namespace:

System.Text.Encodings.Web

Assembly:

System.Text.Encodings.Web.dll

Source:

TextEncoder.cs

Important

This API is not CLS-compliant.

Encodes a Unicode scalar value and writes it to a buffer.

public:
 abstract bool TryEncodeUnicodeScalar(int unicodeScalar, char* buffer, int bufferLength, [Runtime::InteropServices::Out] int % numberOfCharactersWritten);

[System.CLSCompliant(false)]
public abstract bool TryEncodeUnicodeScalar (int unicodeScalar, char* buffer, int bufferLength, out int numberOfCharactersWritten);

[<System.CLSCompliant(false)>]
abstract member TryEncodeUnicodeScalar : int * nativeptr<char> * int * int -> bool

Parameters

unicodeScalar

Int32

A Unicode scalar value.

buffer

Char*

A pointer to the buffer to which to write the encoded text.

bufferLength

Int32

The length of the destination buffer in characters.

numberOfCharactersWritten

Int32

When the method returns, indicates the number of characters written to the buffer.

Returns

Boolean

false if bufferLength is too small to fit the encoded text; otherwise, returns true.

Attributes

CLSCompliantAttribute

Remarks

This method is seldom called directly. One of the Encode overloads should be used instead. Implementations of the TextEncoder class must be thread-safe and stateless.