Socket.BeginSendFile メソッド

ソース:

Socket.cs

ソース:

Socket.cs

ソース:

Socket.cs

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

パラメーター

戻り値

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

例外

注釈

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

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

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

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

ソース:

Socket.cs

ソース:

Socket.cs

ソース:

Socket.cs

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

パラメーター

戻り値

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

例外

注釈

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

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

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

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

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