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