Socket.BeginSendFile メソッド

リファレンス

定義

名前空間:: System.Net.Sockets

アセンブリ:: System.Net.Sockets.dll

アセンブリ:: System.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

接続された Socket オブジェクトに、ファイルを非同期的に送信します。

オーバーロード

BeginSendFile(String, AsyncCallback, Object)	UseDefaultWorkerThread フラグを使用して、接続されている Socket オブジェクトにファイル `fileName` を送信します。
BeginSendFile(String, Byte[], Byte[], TransmitFileOptions, AsyncCallback, Object)	接続された Socket オブジェクトに、ファイルとデータのバッファーを非同期的に送信します。

BeginSendFile(String, AsyncCallback, Object)

ソース:: Socket.cs

ソース:: Socket.cs

ソース:: Socket.cs

UseDefaultWorkerThread フラグを使用して、接続されている Socket オブジェクトにファイル fileName を送信します。

public:
 IAsyncResult ^ BeginSendFile(System::String ^ fileName, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginSendFile (string fileName, AsyncCallback? callback, object? state);

public IAsyncResult BeginSendFile (string? fileName, AsyncCallback? callback, object? state);

public IAsyncResult BeginSendFile (string fileName, AsyncCallback callback, object state);

member this.BeginSendFile : string * AsyncCallback * obj -> IAsyncResult

Public Function BeginSendFile (fileName As String, callback As AsyncCallback, state As Object) As IAsyncResult

パラメーター

fileName: String

送信するファイルのパスと名前を格納する文字列。このパラメーターは、null に設定できます。

callback: AsyncCallback

AsyncCallback デリゲート。

state: Object

この要求の状態情報を格納するオブジェクト。

戻り値

IAsyncResult

非同期送信を表す IAsyncResult オブジェクト。

例外

ObjectDisposedException

Socket オブジェクトは閉じられています。

NotSupportedException

ソケットがリモートホストに接続されていません。

FileNotFoundException

ファイル fileName が見つかりませんでした。

SocketException

.NET Framework および .NET 5 以前のみ: ソケットにアクセスしようとしたときにエラーが発生しました。以下の解説を参照してください。

注釈

重要

これは互換性 API です。新しい開発に APM (Begin* および End*) メソッドを使用することはお勧めしません。代わりに、ベースの Task同等のものを使用します。

このオーバーロードは、ソケット経由でファイル fileName を送信します。がローカルディレクトリ内にある場合 fileName は、ファイルの名前だけで識別できます。それ以外の場合は、ファイルの完全なパスと名前を指定する必要があります。ワイルドカード ("..\\myfile.txt") と UNC 共有名 ("\\\\shared directory\\myfile.txt") がサポートされています。ファイルが見つからない場合は、例外 FileNotFoundException がスローされます。

を実装AsyncCallback BeginSendFileするコールバックを渡して、操作の完了に関する通知を受け取ることができます。基になるネットワークスタックが同期的に操作を完了すると、への呼び出し BeginSendFile中にコールバックがインラインで実行されることに注意してください。この場合、 CompletedSynchronously 返される IAsyncResult のプロパティはに true 設定され、メソッドが同期的に完了したことを示します。メソッドに AsyncState 渡される状態オブジェクトを取得するには、のプロパティ IAsyncResult を BeginSendFile 使用します。

メソッドを BeginSendFile 呼び出して操作を完了する EndSendFile 必要があります。通常、メソッドはデリゲートによって AsyncCallback 呼び出されます。 EndSendFile は、操作が完了するまで呼び出し元のスレッドをブロックします。

接続指向プロトコルを対象としていますが、 BeginSendFile またはメソッドを最初に呼び出してConnect BeginConnect既定のリモートホストを確立する場合は、コネクションレスプロトコルでも機能します。コネクションレスプロトコルでは、ファイルのサイズが基になるサービスプロバイダーの最大パケットサイズを超えていないことを確認する必要があります。送信された場合、データグラムは送信されず、 BeginSendFile 例外が SocketException スローされます。

注意

例外が発生した場合は SocketException 、プロパティを SocketException.ErrorCode 使用して特定のエラーコードを取得します。

Note

このメンバーは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「.NET Frameworkのネットワークトレース」を参照してください。

注意

実行コンテキスト (セキュリティコンテキスト、偽装されたユーザー、および呼び出し元のコンテキスト) は、非同期 Socket メソッド用にキャッシュされます。特定のコンテキスト (特定の非同期 Socket メソッド、特定 Socket のインスタンス、および特定のコールバック) を最初に使用した後、そのコンテキストを後続で使用すると、パフォーマンスが向上します。

適用対象

BeginSendFile(String, Byte[], Byte[], TransmitFileOptions, AsyncCallback, Object)

ソース:: Socket.cs

ソース:: Socket.cs

ソース:: Socket.cs

接続された Socket オブジェクトに、ファイルとデータのバッファーを非同期的に送信します。

public:
 IAsyncResult ^ BeginSendFile(System::String ^ fileName, cli::array <System::Byte> ^ preBuffer, cli::array <System::Byte> ^ postBuffer, System::Net::Sockets::TransmitFileOptions flags, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginSendFile (string? fileName, byte[]? preBuffer, byte[]? postBuffer, System.Net.Sockets.TransmitFileOptions flags, AsyncCallback? callback, object? state);

public IAsyncResult BeginSendFile (string fileName, byte[] preBuffer, byte[] postBuffer, System.Net.Sockets.TransmitFileOptions flags, AsyncCallback callback, object state);

member this.BeginSendFile : string * byte[] * byte[] * System.Net.Sockets.TransmitFileOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginSendFile (fileName As String, preBuffer As Byte(), postBuffer As Byte(), flags As TransmitFileOptions, callback As AsyncCallback, state As Object) As IAsyncResult

パラメーター

fileName: String

送信されるファイルのパスと名前を格納する文字列。このパラメーターは、null に設定できます。

preBuffer: Byte[]

ファイルが送信される前に送信されるデータ。このパラメーターは、null に設定できます。

postBuffer: Byte[]

ファイルの送信後に送信されるデータ。このパラメーターは、null に設定できます。

flags: TransmitFileOptions

列挙値のビットごとの組み合わせ。

callback: AsyncCallback

このオプションの完了時に呼び出される AsyncCallback デリゲート。このパラメーターは、null に設定できます。

state: Object

この要求の状態情報を格納するユーザー定義のオブジェクト。このパラメーターは、null に設定できます。

戻り値

IAsyncResult

非同期操作を表す IAsyncResult オブジェクト。

例外

ObjectDisposedException

Socket オブジェクトは閉じられています。

SocketException

.NET Framework および .NET 5 以前のみ: ソケットにアクセスしようとしたときにエラーが発生しました。以下の解説を参照してください。

NotSupportedException

オペレーティングシステムは Windows NT 以降ではありません。

- または -

ソケットがリモートホストに接続されていません。

FileNotFoundException

ファイル fileName が見つかりませんでした。

注釈

重要

このオーバーロードには、送信するファイルの名前と、値のビットごとの組み合わせが TransmitFileOptions 必要です。パラメーターには preBuffer 、ファイルの前に必要なデータが含まれています。 postBuffer には、ファイルに従うデータが含まれています。がローカルディレクトリ内にある場合 fileName は、ファイルの名前だけで識別できます。それ以外の場合は、ファイルの完全なパスと名前を指定する必要があります。ワイルドカード ("..\\myfile.txt") と UNC 共有名 ("\\\\shared directory\\myfile.txt") がサポートされています。ファイルが見つからない場合は、例外 FileNotFoundException がスローされます。

パラメーターは flags 、ファイル転送に関する追加情報を提供します。このパラメーターの使用方法の詳細については、「」を参照してください TransmitFileOptions。

メソッドを BeginSendFile 呼び出して操作を完了する EndSendFile 必要があります。通常、メソッドは、指定された AsyncCallback デリゲートによって呼び出されます。 EndSendFile は、操作が完了するまで呼び出し元のスレッドをブロックします。

注意

例外が発生した場合は SocketException 、プロパティを SocketException.ErrorCode 使用して特定のエラーコードを取得します。

Note

注意

適用対象

次の方法で共有

Socket.BeginSendFile メソッド

定義

オーバーロード

BeginSendFile(String, AsyncCallback, Object)

パラメーター

戻り値

例外

注釈

適用対象

BeginSendFile(String, Byte[], Byte[], TransmitFileOptions, AsyncCallback, Object)

パラメーター

戻り値

例外

注釈

適用対象

その他のリソース