Socket.SendFile メソッド

定義

接続された Socket に、ファイルおよびオプション データを同期的に送信します。Sends a file and optional data synchronously to a connected Socket.

オーバーロード

SendFile(String)

UseDefaultWorkerThread 送信フラグを使用して、接続されている Socket オブジェクトにファイル fileName を送信します。Sends the file fileName to a connected Socket object with the UseDefaultWorkerThread transmit flag.

SendFile(String, Byte[], Byte[], TransmitFileOptions)

指定した TransmitFileOptions 値を使用して、接続された Socket オブジェクトにファイル fileName およびデータのバッファーを送信します。Sends the file fileName and buffers of data to a connected Socket object using the specified TransmitFileOptions value.

SendFile(String)

UseDefaultWorkerThread 送信フラグを使用して、接続されている Socket オブジェクトにファイル fileName を送信します。Sends the file fileName to a connected Socket object with the UseDefaultWorkerThread transmit flag.

public:
 void SendFile(System::String ^ fileName);
public void SendFile (string fileName);
member this.SendFile : string -> unit
Public Sub SendFile (fileName As String)

パラメーター

fileName
String

送信されるファイルのパスと名前を含む StringA String that contains the path and name of the file to be sent. このパラメーターは、null に設定できます。This parameter can be null.

例外

ソケットがリモート ホストに接続されていません。The socket is not connected to a remote host.

Socket オブジェクトは閉じられています。The Socket object has been closed.

Socket オブジェクトはブロック モードではなく、この同期呼び出しを受け付けることができません。The Socket object is not in blocking mode and cannot accept this synchronous call.

ファイル fileName が見つかりませんでした。The file fileName was not found.

ソケットへのアクセスを試行しているときにエラーが発生しました。An error occurred when attempting to access the socket.

次のコード例では、ソケットを作成して接続し、リモートホストにファイルを送信します。The following code example creates and connects a socket and then sends a file to the remote host. ファイル "test.txt" は、ローカルコンピューターのルートディレクトリにあります。The file "test.txt" is located in the root directory of the local machine.

// Establish the local endpoint for the socket.
IPHostEntry^ ipHost = Dns::GetHostEntry( Dns::GetHostName() );
IPAddress^ ipAddr = ipHost->AddressList[ 0 ];
IPEndPoint^ ipEndPoint = gcnew IPEndPoint( ipAddr,11000 );

// Create a TCP socket.
Socket^ client = gcnew Socket( AddressFamily::InterNetwork,SocketType::Stream,ProtocolType::Tcp );

// Connect the socket to the remote endpoint.
client->Connect( ipEndPoint );

// There is a text file test.txt located in the root directory.
String^ fileName = "C:\\test.txt";

// Send file fileName to remote device
Console::WriteLine( "Sending {0} to the host.", fileName );
client->SendFile( fileName );

// Release the socket.
client->Shutdown( SocketShutdown::Both );
client->Close();
    // Establish the local endpoint for the socket.
    IPHostEntry ipHost = Dns.GetHostEntry(Dns.GetHostName());
    IPAddress  ipAddr = ipHost.AddressList[0];
    IPEndPoint ipEndPoint = new IPEndPoint(ipAddr, 11000);

    // Create a TCP socket.
    Socket client = new Socket(AddressFamily.InterNetwork,
            SocketType.Stream, ProtocolType.Tcp);

    // Connect the socket to the remote endpoint.
    client.Connect(ipEndPoint);

    // There is a text file test.txt located in the root directory.
    string fileName = "C:\\test.txt";

    // Send file fileName to remote device
    Console.WriteLine("Sending {0} to the host.", fileName);
    client.SendFile(fileName);

    // Release the socket.
    client.Shutdown(SocketShutdown.Both);
    client.Close();

注釈

このオーバーロードは、接続されているソケットにファイル fileName を送信します。This overload sends the file fileName to the connected socket. flags パラメーターの既定値は UseDefaultWorkerThread (0) で、preBufferpostBuffer のパラメーターは既定で nullに設定されています。The flags parameter defaults to UseDefaultWorkerThread (0), and the preBuffer and postBuffer parameters default to null. fileName がローカルディレクトリにある場合は、ファイル名だけで識別できます。それ以外の場合は、ファイルの完全なパスと名前を指定する必要があります。If fileName is in the local directory, it may be identified with just the name of the file; otherwise, the full path and name of the file must be specified. ワイルドカード ("..\\myfile.txt ") と UNC 共有名 ("\\\\ 共有ディレクトリ\\myfile.txt ") はサポートされています。Wildcards ("..\\myfile.txt") and UNC share names ("\\\\shared directory\\myfile.txt") are supported. ファイルが見つからない場合は、例外 FileNotFoundException がスローされます。If the file is not found, the exception FileNotFoundException is thrown.

このメソッドは、Windows Sockets 2 API の TransmitFile 関数を使用します。This method uses the TransmitFile function found in the Windows Sockets 2 API. TransmitFile 関数とそのフラグの詳細については、 Windows Socketsのドキュメントを参照してください。For more information about the TransmitFile function and its flags, see the Windows Sockets documentation.

SendFile は、Connect または Accept メソッドで指定されたリモートホストにファイルを同期的に送信します。SendFile synchronously sends a file to the remote host specified in the Connect or Accept method. SendFile は、接続指向プロトコルとコネクションレスプロトコルの両方に使用できます。SendFile can be used for both connection-oriented and for connectionless protocols.

コネクションレスプロトコルを使用している場合は、このメソッドを呼び出す前に Connect を呼び出す必要があります。そうしないと SendFileSocketException 例外をスローします。If you are using a connectionless protocol, you must call Connect before calling this method, otherwise SendFile throws a SocketException exception. 接続指向プロトコルを使用している場合は、Connect を使用してリモートホスト接続を確立するか、Accept を使用して受信接続を受け入れる必要があります。If you are using a connection-oriented protocol, you must either use Connect to establish a remote host connection or use Accept to accept an incoming connection.

接続指向プロトコルを使用している場合、SendFile は、ファイルが送信されるまでブロックします。If you are using a connection-oriented protocol, SendFile blocks until the file is sent. 非ブロッキングモードでは、ファイル全体が送信される前に SendFile が正常に完了することがあります。In nonblocking mode, SendFile may complete successfully before the entire file has been sent. 送信したデータがネットワークに直ちに表示される保証はありません。There is no guarantee that the data you send will appear on the network immediately. ネットワークの効率を向上させるために、基になるシステムは、大量の送信データが収集されるまで転送を遅らせます。To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. SendFile メソッドが正常に完了すると、基になるシステムにネットワーク送信用のデータをバッファーするための余裕があることを意味します。A successful completion of the SendFile method means that the underlying system has had room to buffer your data for a network send.

注意

SocketExceptionを受け取った場合は、SocketException.ErrorCode プロパティを使用して、特定のエラーコードを取得します。If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. このコードを取得したら、 Windows Sockets version 2 API エラーコードのドキュメントを参照して、エラーの詳細な説明を参照してください。After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。This member outputs trace information when you enable network tracing in your application. 詳細については、「 .NET Framework のネットワークトレース」を参照してください。For more information, see Network Tracing in the .NET Framework.

SendFile(String, Byte[], Byte[], TransmitFileOptions)

指定した TransmitFileOptions 値を使用して、接続された Socket オブジェクトにファイル fileName およびデータのバッファーを送信します。Sends the file fileName and buffers of data to a connected Socket object using the specified TransmitFileOptions value.

public:
 void SendFile(System::String ^ fileName, cli::array <System::Byte> ^ preBuffer, cli::array <System::Byte> ^ postBuffer, System::Net::Sockets::TransmitFileOptions flags);
public void SendFile (string fileName, byte[] preBuffer, byte[] postBuffer, System.Net.Sockets.TransmitFileOptions flags);
member this.SendFile : string * byte[] * byte[] * System.Net.Sockets.TransmitFileOptions -> unit
Public Sub SendFile (fileName As String, preBuffer As Byte(), postBuffer As Byte(), flags As TransmitFileOptions)

パラメーター

fileName
String

送信されるファイルのパスと名前を含む StringA String that contains the path and name of the file to be sent. このパラメーターは、null に設定できます。This parameter can be null.

preBuffer
Byte[]

ファイルが送信される前に送信されるデータを格納する Byte 配列。A Byte array that contains data to be sent before the file is sent. このパラメーターは、null に設定できます。This parameter can be null.

postBuffer
Byte[]

ファイルが送信された後で送信されるデータを格納する Byte 配列。A Byte array that contains data to be sent after the file is sent. このパラメーターは、null に設定できます。This parameter can be null.

flags
TransmitFileOptions

1 つ以上の TransmitFileOptions 値。One or more of TransmitFileOptions values.

例外

オペレーティング システムは Windows NT 以降ではありません。The operating system is not Windows NT or later.

- または --or-

ソケットがリモート ホストに接続されていません。The socket is not connected to a remote host.

Socket オブジェクトは閉じられています。The Socket object has been closed.

Socket オブジェクトはブロック モードではなく、この同期呼び出しを受け付けることができません。The Socket object is not in blocking mode and cannot accept this synchronous call.

ファイル fileName が見つかりませんでした。The file fileName was not found.

ソケットへのアクセスを試行しているときにエラーが発生しました。An error occurred when attempting to access the socket.

次のコード例では、ソケットを作成して接続します。The following code example creates and connects a socket. ファイル "test.txt" は、ローカルコンピューターのルートディレクトリにあります。The file "test.txt" is located in the root directory of the local machine. この例では、データの prebuffer と postbuffer を作成し、ファイルを使用してリモートホストに送信します。In this example, we create a prebuffer and postbuffer of data and send them to the remote host with the file. 既定の TransmitFileOptions が使用されます。The default TransmitFileOptions are used.

// Establish the local endpoint for the socket.
IPHostEntry^ ipHost = Dns::GetHostEntry( Dns::GetHostName() );
IPAddress^ ipAddr = ipHost->AddressList[ 0 ];
IPEndPoint^ ipEndPoint = gcnew IPEndPoint( ipAddr,11000 );

// Create a TCP socket.
Socket^ client = gcnew Socket( AddressFamily::InterNetwork,SocketType::Stream,ProtocolType::Tcp );

// Connect the socket to the remote endpoint.
client->Connect( ipEndPoint );

// Send file fileName to the remote host with preBuffer and postBuffer data.
// There is a text file test.txt located in the root directory.
String^ fileName = "C:\\test.txt";

// Create the preBuffer data.
String^ string1 = String::Format( "This is text data that precedes the file.{0}", Environment::NewLine );
array<Byte>^preBuf = Encoding::ASCII->GetBytes( string1 );

// Create the postBuffer data.
String^ string2 = String::Format( "This is text data that will follow the file.{0}", Environment::NewLine );
array<Byte>^postBuf = Encoding::ASCII->GetBytes( string2 );

//Send file fileName with buffers and default flags to the remote device.
Console::WriteLine( "Sending {0} with buffers to the host.{1}", fileName, Environment::NewLine );
client->SendFile( fileName, preBuf, postBuf, TransmitFileOptions::UseDefaultWorkerThread );

// Release the socket.
client->Shutdown( SocketShutdown::Both );
client->Close();
     // Establish the local endpoint for the socket.
     IPHostEntry ipHost = Dns.GetHostEntry(Dns.GetHostName());
     IPAddress  ipAddr = ipHost.AddressList[0];
     IPEndPoint ipEndPoint = new IPEndPoint(ipAddr, 11000);

     // Create a TCP socket.
     Socket client = new Socket(AddressFamily.InterNetwork,
             SocketType.Stream, ProtocolType.Tcp);

     // Connect the socket to the remote endpoint.
     client.Connect(ipEndPoint);

     // Send file fileName to the remote host with preBuffer and postBuffer data.
     // There is a text file test.txt located in the root directory.
     string fileName = "C:\\test.txt";

     // Create the preBuffer data.
     string string1 = String.Format("This is text data that precedes the file.{0}", Environment.NewLine);
     byte[] preBuf = Encoding.ASCII.GetBytes(string1);

     // Create the postBuffer data.
     string string2 = String.Format("This is text data that will follow the file.{0}", Environment.NewLine);
     byte[] postBuf = Encoding.ASCII.GetBytes(string2);

     //Send file fileName with buffers and default flags to the remote device.
     Console.WriteLine("Sending {0} with buffers to the host.{1}", fileName, Environment.NewLine);
     client.SendFile(fileName, preBuf, postBuf, TransmitFileOptions.UseDefaultWorkerThread);

     // Release the socket.
     client.Shutdown(SocketShutdown.Both);
     client.Close();

注釈

このオーバーロードには、送信するファイルの名前と TransmitFileOptions 値のビットごとの組み合わせが必要です。This overload requires the name of the file you want to send and a bitwise combination of TransmitFileOptions values. preBuffer パラメーターには、ファイルの前に配置するデータが含まれています。The preBuffer parameter contains any data you want to precede the file. postBuffer には、ファイルに従う必要があるデータが含まれています。postBuffer contains data you want to follow the file. fileName が現在の作業ディレクトリにある場合は、ファイル名だけで識別できます。それ以外の場合は、ファイルの完全なパスと名前を指定する必要があります。If fileName is in the current working directory, it may be identified with just the name of the file; otherwise, the full path and name of the file must be specified. ワイルドカード ("..\\myfile.txt ") と UNC 共有名 ("\\\\ 共有ディレクトリ\\myfile.txt ") はサポートされています。Wildcards ("..\\myfile.txt") and UNC share names ("\\\\shared directory\\myfile.txt") are supported.

flags パラメーターは、ファイル転送に関する追加情報を Window Sockets service プロバイダーに提供します。The flags parameter provides the Window Sockets service provider with additional information about the file transfer. このパラメーターの使用方法の詳細については、「TransmitFileOptions」を参照してください。For more information about how to use this parameter, see TransmitFileOptions.

このメソッドは、Windows Sockets 2 API の TransmitFile 関数を使用します。This method uses the TransmitFile function found in the Windows Sockets 2 API. TransmitFile 関数とそのフラグの詳細については、 Windows Socketsのドキュメントを参照してください。For more information about the TransmitFile function and its flags, see the Windows Sockets documentation.

SendFile は、Connect または Accept メソッドで指定されたリモートホストにファイルを同期的に送信します。SendFile synchronously sends a file to the remote host specified in the Connect or Accept method. SendFile は、接続指向プロトコルとコネクションレスプロトコルの両方に使用できます。SendFile can be used for both connection-oriented and for connectionless protocols.

コネクションレスプロトコルを使用している場合は、このメソッドを呼び出す前に Connect を呼び出す必要があります。それ以外の場合 SendFileSocketExceptionをスローします。If you are using a connectionless protocol, you must call Connect before calling this method; otherwise SendFile throws a SocketException. 接続指向プロトコルを使用している場合は、Connect を使用してリモートホスト接続を確立するか、Accept を使用して受信接続を許可する必要があります。If you are using a connection-oriented protocol, you must either use Connect to establish a remote host connection, or use Accept to accept an incoming connection.

接続指向プロトコルを使用している場合、SendFile は、ファイル全体が送信されるまでブロックします。If you are using a connection-oriented protocol, SendFile blocks until the entire file is sent. 非ブロッキングモードでは、ファイル全体が送信される前に SendFile が正常に完了することがあります。In nonblocking mode, SendFile may complete successfully before the entire file has been sent. 送信したデータがネットワークに直ちに表示される保証はありません。There is no guarantee that the data you send will appear on the network immediately. ネットワークの効率を向上させるために、基になるシステムは、大量の送信データが収集されるまで転送を遅らせます。To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. SendFile メソッドが正常に完了すると、基になるシステムにネットワーク送信用のデータをバッファーするための余裕があることを意味します。A successful completion of the SendFile method means that the underlying system has had room to buffer your data for a network send.

注意

SocketExceptionを受け取った場合は、SocketException.ErrorCode プロパティを使用して、特定のエラーコードを取得します。If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. このコードを取得したら、 Windows Sockets version 2 API エラーコードのドキュメントを参照して、エラーの詳細な説明を参照してください。After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。This member outputs trace information when you enable network tracing in your application. 詳細については、「 .NET Framework のネットワークトレース」を参照してください。For more information, see Network Tracing in the .NET Framework.

適用対象