SourceText.From 方法

定義

命名空間:

Microsoft.CodeAnalysis.Text

組件:

Microsoft.CodeAnalysis.dll

套件:

Microsoft.CodeAnalysis.Common v4.9.2

多載

From(String, Encoding, SourceHashAlgorithm)	SourceText從字串中的文字建構 。
From(Stream, Encoding, SourceHashAlgorithm, Boolean)
From(TextReader, Int32, Encoding, SourceHashAlgorithm)	SourceText從字串中的文字建構 。
From(Byte[], Int32, Encoding, SourceHashAlgorithm, Boolean)
From(Stream, Encoding, SourceHashAlgorithm, Boolean, Boolean)	SourceText從資料流程內容建構 。
From(Byte[], Int32, Encoding, SourceHashAlgorithm, Boolean, Boolean)	SourceText從位元組陣列建構 。

From(String, Encoding, SourceHashAlgorithm)

Source:

SourceText.cs

SourceText從字串中的文字建構 。

public static Microsoft.CodeAnalysis.Text.SourceText From (string text, System.Text.Encoding? encoding = default, Microsoft.CodeAnalysis.Text.SourceHashAlgorithm checksumAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1);

static member From : string * System.Text.Encoding * Microsoft.CodeAnalysis.Text.SourceHashAlgorithm -> Microsoft.CodeAnalysis.Text.SourceText

Public Shared Function From (text As String, Optional encoding As Encoding = Nothing, Optional checksumAlgorithm As SourceHashAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1) As SourceText

參數

text

String

Text。

encoding

Encoding

讀取或將要儲存之檔案 text 的編碼方式。 null 如果未指定編碼，則為 。 如果未指定編碼方式，則結果 SourceText 無法偵錯。 如果將無 SourceText 編碼寫入檔案， UTF8 則應該使用 做為預設值。

checksumAlgorithm

SourceHashAlgorithm

用來計算儲存至 PDB 之文字總和檢查碼的雜湊演算法。

傳回

SourceText

例外狀況

ArgumentNullException

text 為 null。

ArgumentException

不支援 checksumAlgorithm。

From(Stream, Encoding, SourceHashAlgorithm, Boolean)

Source:

SourceText.cs

public:
 static Microsoft::CodeAnalysis::Text::SourceText ^ From(System::IO::Stream ^ stream, System::Text::Encoding ^ encoding, Microsoft::CodeAnalysis::Text::SourceHashAlgorithm checksumAlgorithm, bool throwIfBinaryDetected);

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
public static Microsoft.CodeAnalysis.Text.SourceText From (System.IO.Stream stream, System.Text.Encoding? encoding, Microsoft.CodeAnalysis.Text.SourceHashAlgorithm checksumAlgorithm, bool throwIfBinaryDetected);

[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]
static member From : System.IO.Stream * System.Text.Encoding * Microsoft.CodeAnalysis.Text.SourceHashAlgorithm * bool -> Microsoft.CodeAnalysis.Text.SourceText

Public Shared Function From (stream As Stream, encoding As Encoding, checksumAlgorithm As SourceHashAlgorithm, throwIfBinaryDetected As Boolean) As SourceText

參數

stream

Stream

encoding

Encoding

checksumAlgorithm

SourceHashAlgorithm

throwIfBinaryDetected

Boolean

傳回

SourceText

屬性

EditorBrowsableAttribute

From(TextReader, Int32, Encoding, SourceHashAlgorithm)

Source:

SourceText.cs

SourceText從字串中的文字建構 。

public static Microsoft.CodeAnalysis.Text.SourceText From (System.IO.TextReader reader, int length, System.Text.Encoding? encoding = default, Microsoft.CodeAnalysis.Text.SourceHashAlgorithm checksumAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1);

static member From : System.IO.TextReader * int * System.Text.Encoding * Microsoft.CodeAnalysis.Text.SourceHashAlgorithm -> Microsoft.CodeAnalysis.Text.SourceText

Public Shared Function From (reader As TextReader, length As Integer, Optional encoding As Encoding = Nothing, Optional checksumAlgorithm As SourceHashAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1) As SourceText

參數

reader

TextReader

TextReader

length

Int32

內容的長度 reader

encoding

Encoding

讀取或將要儲存之檔案 reader 的編碼方式。 null 如果未指定編碼，則為 。 如果未指定編碼方式，則結果 SourceText 無法偵錯。 如果將無 SourceText 編碼寫入檔案， UTF8 則應該使用 做為預設值。

checksumAlgorithm

SourceHashAlgorithm

用來計算儲存至 PDB 之文字總和檢查碼的雜湊演算法。

傳回

SourceText

例外狀況

ArgumentNullException

reader 為 null。

ArgumentException

不支援 checksumAlgorithm。

From(Byte[], Int32, Encoding, SourceHashAlgorithm, Boolean)

Source:

SourceText.cs

public:
 static Microsoft::CodeAnalysis::Text::SourceText ^ From(cli::array <System::Byte> ^ buffer, int length, System::Text::Encoding ^ encoding, Microsoft::CodeAnalysis::Text::SourceHashAlgorithm checksumAlgorithm, bool throwIfBinaryDetected);

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
public static Microsoft.CodeAnalysis.Text.SourceText From (byte[] buffer, int length, System.Text.Encoding? encoding, Microsoft.CodeAnalysis.Text.SourceHashAlgorithm checksumAlgorithm, bool throwIfBinaryDetected);

[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]
static member From : byte[] * int * System.Text.Encoding * Microsoft.CodeAnalysis.Text.SourceHashAlgorithm * bool -> Microsoft.CodeAnalysis.Text.SourceText

Public Shared Function From (buffer As Byte(), length As Integer, encoding As Encoding, checksumAlgorithm As SourceHashAlgorithm, throwIfBinaryDetected As Boolean) As SourceText

參數

buffer

Byte[]

length

Int32

encoding

Encoding

checksumAlgorithm

SourceHashAlgorithm

throwIfBinaryDetected

Boolean

傳回

SourceText

屬性

EditorBrowsableAttribute

From(Stream, Encoding, SourceHashAlgorithm, Boolean, Boolean)

Source:

SourceText.cs

SourceText從資料流程內容建構 。

public static Microsoft.CodeAnalysis.Text.SourceText From (System.IO.Stream stream, System.Text.Encoding? encoding = default, Microsoft.CodeAnalysis.Text.SourceHashAlgorithm checksumAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1, bool throwIfBinaryDetected = false, bool canBeEmbedded = false);

static member From : System.IO.Stream * System.Text.Encoding * Microsoft.CodeAnalysis.Text.SourceHashAlgorithm * bool * bool -> Microsoft.CodeAnalysis.Text.SourceText

Public Shared Function From (stream As Stream, Optional encoding As Encoding = Nothing, Optional checksumAlgorithm As SourceHashAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1, Optional throwIfBinaryDetected As Boolean = false, Optional canBeEmbedded As Boolean = false) As SourceText

參數

stream

Stream

資料流。 資料流程必須是可搜尋的。

encoding

Encoding

如果資料流程不是以位元組順序標記開始指定編碼，則要使用的資料編碼。 UTF8 如果未指定，則為 。

checksumAlgorithm

SourceHashAlgorithm

用來計算儲存至 PDB 之文字總和檢查碼的雜湊演算法。

throwIfBinaryDetected

Boolean

如果解碼的文字至少包含兩個連續 NUL 字元，則會 InvalidDataException 擲回 。

canBeEmbedded

Boolean

True 是表示 如果文字可以傳遞至 FromSource(String, SourceText) PDB 並內嵌在 PDB 中。

傳回

SourceText

例外狀況

ArgumentNullException

stream 為 null。

ArgumentException

stream 不支援讀取或搜尋。 不支援 checksumAlgorithm。

DecoderFallbackException

如果指定的編碼設定為使用擲回解碼器做為後援

InvalidDataException

在解碼的文字中偵測到兩個連續 NUL 字元，且 throwIfBinaryDetected 為 true。

IOException

發生 I/O 錯誤。

備註

從資料流程開頭讀取。 讓資料流程保持開啟狀態。

From(Byte[], Int32, Encoding, SourceHashAlgorithm, Boolean, Boolean)

Source:

SourceText.cs

SourceText從位元組陣列建構 。

public static Microsoft.CodeAnalysis.Text.SourceText From (byte[] buffer, int length, System.Text.Encoding? encoding = default, Microsoft.CodeAnalysis.Text.SourceHashAlgorithm checksumAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1, bool throwIfBinaryDetected = false, bool canBeEmbedded = false);

static member From : byte[] * int * System.Text.Encoding * Microsoft.CodeAnalysis.Text.SourceHashAlgorithm * bool * bool -> Microsoft.CodeAnalysis.Text.SourceText

Public Shared Function From (buffer As Byte(), length As Integer, Optional encoding As Encoding = Nothing, Optional checksumAlgorithm As SourceHashAlgorithm = Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1, Optional throwIfBinaryDetected As Boolean = false, Optional canBeEmbedded As Boolean = false) As SourceText

參數

buffer

Byte[]

編碼的來源緩衝區。

length

Int32

要從緩衝區讀取的位元組數目。

encoding

Encoding

如果編碼的緩衝區不是以 Byte Order Mark 開頭，則要使用的資料編碼。 UTF8 如果未指定，則為 。

checksumAlgorithm

SourceHashAlgorithm

用來計算儲存至 PDB 之文字總和檢查碼的雜湊演算法。

throwIfBinaryDetected

Boolean

如果解碼的文字至少包含兩個連續 NUL 字元，則會 InvalidDataException 擲回 。

canBeEmbedded

Boolean

True 是表示 如果文字可以傳遞至 FromSource(String, SourceText) PDB 並內嵌在 PDB 中。

傳回

SourceText

解碼的文字。

例外狀況

ArgumentNullException

buffer 為 Null。

ArgumentOutOfRangeException

length為負數或大於 buffer 。

ArgumentException

不支援 checksumAlgorithm。

DecoderFallbackException

如果指定的編碼設定為使用擲回解碼器做為後援

InvalidDataException

在解碼的文字中偵測到兩個連續 NUL 字元，且 throwIfBinaryDetected 為 true。