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

Definition

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);
abstract member TryEncodeUnicodeScalar : int * nativeptr<char> * int *  -> bool

Parameters

unicodeScalar
Int32 Int32 Int32

A Unicode scalar value.

buffer
Char*

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

bufferLength
Int32 Int32 Int32

The length of the destination buffer in characters.

numberOfCharactersWritten
Int32 Int32 Int32

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

Returns

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

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.

Applies to