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

エンコード操作の結果を記述する列挙値。

注釈

バッファーをdestination重複sourceさせる必要があります。