TextEncoder.Encode Метод

Определение

Пространство имен:

System.Text.Encodings.Web

Сборка:

System.Text.Encodings.Web.dll

Перегрузки

Encode(String)	Кодирует указанную строку и возвращает кодированный текст в виде новой строки.
Encode(TextWriter, String)	Кодирует указанную строку в объект TextWriter.
Encode(TextWriter, Char[], Int32, Int32)	Кодирует символы из массива и записывает их в объект TextWriter.
Encode(TextWriter, String, Int32, Int32)	Кодирует подстроку и записывает ее в объект TextWriter.
Encode(ReadOnlySpan<Char>, Span<Char>, Int32, Int32, Boolean)	Кодирует указанные символы.

Encode(String)

Кодирует указанную строку и возвращает кодированный текст в виде новой строки.

public:
 virtual System::String ^ Encode(System::String ^ value);

public virtual string Encode (string value);

abstract member Encode : string -> string
override this.Encode : string -> string

Public Overridable Function Encode (value As String) As String

Параметры

value

String

Кодируемая строка.

Возвращаемое значение

String

Закодированная строка.

Исключения

ArgumentNullException

value имеет значение null.

ArgumentException

Метод TryEncodeUnicodeScalar(Int32, Char*, Int32, Int32) завершился сбоем. Кодировщик не реализует MaxOutputCharactersPerInputCharacter правильно.

Encode(TextWriter, String)

Кодирует указанную строку в объект TextWriter.

public:
 void Encode(System::IO::TextWriter ^ output, System::String ^ value);

public void Encode (System.IO.TextWriter output, string value);

member this.Encode : System.IO.TextWriter * string -> unit

Public Sub Encode (output As TextWriter, value As String)

Параметры

output

TextWriter

Поток для записи кодированного текста.

value

String

Кодируемая строка.

Encode(TextWriter, Char[], Int32, Int32)

Кодирует символы из массива и записывает их в объект TextWriter.

public:
 virtual void Encode(System::IO::TextWriter ^ output, cli::array <char> ^ value, int startIndex, int characterCount);

public virtual void Encode (System.IO.TextWriter output, char[] value, int startIndex, int characterCount);

abstract member Encode : System.IO.TextWriter * char[] * int * int -> unit
override this.Encode : System.IO.TextWriter * char[] * int * int -> unit

Public Overridable Sub Encode (output As TextWriter, value As Char(), startIndex As Integer, characterCount As Integer)

Параметры

output

TextWriter

Поток для записи кодированного текста.

value

Char[]

Массив символов для кодирования.

startIndex

Int32

Индекс массива первого кодируемого символа.

characterCount

Int32

Количество символов в массиве, которое необходимо кодировать.

Исключения

ArgumentNullException

output имеет значение null.

ArgumentException

Метод TryEncodeUnicodeScalar(Int32, Char*, Int32, Int32) завершился сбоем. Кодировщик не реализует MaxOutputCharactersPerInputCharacter правильно.

ArgumentNullException

value имеет значение null.

ArgumentOutOfRangeException

startIndex выходит за пределы диапазона.

ArgumentOutOfRangeException

characterCount выходит за пределы диапазона.

Encode(TextWriter, String, Int32, Int32)

Кодирует подстроку и записывает ее в объект TextWriter.

public:
 virtual void Encode(System::IO::TextWriter ^ output, System::String ^ value, int startIndex, int characterCount);

public virtual void Encode (System.IO.TextWriter output, string value, int startIndex, int characterCount);

abstract member Encode : System.IO.TextWriter * string * int * int -> unit
override this.Encode : System.IO.TextWriter * string * int * int -> unit

Public Overridable Sub Encode (output As TextWriter, value As String, startIndex As Integer, characterCount As Integer)

Параметры

output

TextWriter

Поток для записи кодированного текста.

value

String

Строка, подстроку которой необходимо кодировать.

startIndex

Int32

Индекс, в котором начинается подстрока.

characterCount

Int32

Число символов в подстроке.

Исключения

ArgumentNullException

output имеет значение null.

ArgumentException

Метод TryEncodeUnicodeScalar(Int32, Char*, Int32, Int32) завершился сбоем. Кодировщик не реализует MaxOutputCharactersPerInputCharacter правильно.

ArgumentNullException

value имеет значение null.

ArgumentOutOfRangeException

startIndex выходит за пределы диапазона.

ArgumentOutOfRangeException

characterCount выходит за пределы диапазона.

Encode(ReadOnlySpan<Char>, Span<Char>, Int32, Int32, Boolean)

Кодирует указанные символы.

public virtual System.Buffers.OperationStatus Encode (ReadOnlySpan<char> source, Span<char> destination, out int charsConsumed, out int charsWritten, bool isFinalBlock = true);

abstract member Encode : ReadOnlySpan<char> * Span<char> * int * int * bool -> System.Buffers.OperationStatus
override this.Encode : ReadOnlySpan<char> * Span<char> * int * int * bool -> System.Buffers.OperationStatus

Public Overridable Function Encode (source As ReadOnlySpan(Of Char), destination As Span(Of Char), ByRef charsConsumed As Integer, ByRef charsWritten As Integer, Optional isFinalBlock As Boolean = true) As OperationStatus

Параметры

source

ReadOnlySpan<Char>

Исходный буфер, содержащий символы для кодирования.

destination

Span<Char>

Буфер назначения, в который будет записана закодированная форма source.

charsConsumed

Int32

Количество символов, использованных из буфера source.

charsWritten

Int32

Количество символов, записанных в буфер destination.

isFinalBlock

Boolean

Значение true, если нет дополнительных исходных данных для кодирования, иначе — false.

Возвращаемое значение

OperationStatus

Значение перечисления, описывающее результат операции кодирования.

Комментарии

Буферы source и destination не должны перекрываться.