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 不得重叠。