Socket.SendFile Methode

  • Referenz

Definition

Namespace:
System.Net.Sockets
Assembly:
System.Net.Sockets.dll
Assembly:
System.dll
Assembly:
netstandard.dll

Sendet eine Datei und optionale Daten synchron an einen verbundenen Socket.

Überlädt

SendFile(String)

Sendet die Datei fileName mit dem Socket-Übertragungsflag an ein verbundenes UseDefaultWorkerThread-Objekt.
SendFile(String, Byte[], Byte[], TransmitFileOptions)

Sendet die Datei fileName und puffert Daten mit dem angegebenen TransmitFileOptions-Wert in einem verbundenen Socket-Objekt.
SendFile(String, ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, TransmitFileOptions)

Sendet die Datei fileName und puffert Daten mit dem angegebenen TransmitFileOptions-Wert in einem verbundenen Socket-Objekt.

SendFile(String)

Sendet die Datei fileName mit dem Socket-Übertragungsflag an ein verbundenes UseDefaultWorkerThread-Objekt.

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

Parameter

fileName
String

Ein String, der den Pfad und Namen der Datei enthält, die gesendet werden soll. Dieser Parameter kann null sein.

Ausnahmen

NotSupportedException

Der Socket ist nicht mit einem Remotehost verbunden.

ObjectDisposedException

Das Socket-Objekt wurde geschlossen.

InvalidOperationException

Das Socket-Objekt ist nicht im Blockierungsmodus und kann diesen synchronen Aufruf nicht annehmen.

FileNotFoundException

Die Datei fileName wurde nicht gefunden.

SocketException

Fehler beim Versuch, auf den Socket zuzugreifen.

Beispiele

Im folgenden Codebeispiel wird ein Socket erstellt und verbunden und dann eine Datei an den Remotehost gesendet. Die Datei "test.txt" befindet sich im Stammverzeichnis des lokalen Computers.

// 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();

Hinweise

Diese Überladung sendet die Datei fileName an den verbundenen Socket. Der flags Parameter ist standardmäßig auf (0) und die preBuffer postBuffer Parameter standardmäßig UseDefaultWorkerThread festgelegtnull. Wenn fileName es sich im lokalen Verzeichnis befindet, kann er nur mit dem Namen der Datei identifiziert werden. Andernfalls muss der vollständige Pfad und der Name der Datei angegeben werden. Wildcards ("..\\myfile.txt") und UNC-Freigabenamen ("\\\\shared directory\\myfile.txt") werden unterstützt. Wenn die Datei nicht gefunden wird, wird die Ausnahme FileNotFoundException ausgelöst.

Diese Methode verwendet die TransmitFile in der Windows Sockets 2-API gefundene Funktion. Weitere Informationen zu der Funktion und ihren Flags finden Sie in der TransmitFile Dokumentation zu Windows Sockets.

SendFilesendet synchron eine Datei an den Remotehost, der in der oder Accept der Connect Methode angegeben ist. SendFile kann sowohl für verbindungsorientierte als auch für verbindungslose Protokolle verwendet werden.

Wenn Sie ein verbindungsloses Protokoll verwenden, müssen Sie vor Connect dem Aufrufen dieser Methode aufrufen, andernfalls SendFile wird eine SocketException Ausnahme ausgelöst. Wenn Sie ein verbindungsorientiertes Protokoll verwenden, müssen Sie entweder Connect eine Remotehostverbindung einrichten oder Accept eine eingehende Verbindung akzeptieren.

Wenn Sie ein verbindungsorientiertes Protokoll verwenden, wird blockiert, SendFile bis die Datei gesendet wird. Im Nichtblockingmodus kann es erfolgreich abgeschlossen werden, SendFile bevor die gesamte Datei gesendet wurde. Es gibt keine Garantie, dass die von Ihnen gesendeten Daten sofort im Netzwerk angezeigt werden. Um die Netzwerkeffizienz zu erhöhen, kann das zugrunde liegende System die Übertragung verzögern, bis eine erhebliche Menge ausgehender Daten erfasst wird. Ein erfolgreicher Abschluss der SendFile Methode bedeutet, dass das zugrunde liegende System Platz zum Puffern Ihrer Daten für eine Netzwerknachricht hatte.

Hinweis

Wenn Sie erhalten eine SocketException, verwenden die SocketException.ErrorCode Eigenschaft, um den spezifischen Fehlercode zu erhalten. Nachdem Sie diesen Code abgerufen haben, finden Sie in der Dokumentation zu Windows Sockets Version 2-API-Fehlercode für eine detaillierte Beschreibung des Fehlers.

Hinweis

Dieser Member gibt Ablaufverfolgungsinformationen aus, wenn Sie die Netzwerkablaufverfolgung in der Anwendung aktivieren. Weitere Informationen finden Sie unter "Netzwerkablaufverfolgung" im .NET Framework.

Gilt für

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

Sendet die Datei fileName und puffert Daten mit dem angegebenen TransmitFileOptions-Wert in einem verbundenen Socket-Objekt.

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);
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)

Parameter

fileName
String

Der Pfad und der Name der zu sendenden Datei. Dieser Parameter kann null sein.

preBuffer
Byte[]

Die zu sendenden Daten, bevor die Datei gesendet wird. Dieser Parameter kann null sein.

postBuffer
Byte[]

Die daten, die nach dem Senden der Datei gesendet werden sollen. Dieser Parameter kann null sein.

flags
TransmitFileOptions

Eine bitweise Kombination der Aufzählungswerte, die angibt, wie die Datei übertragen wird.

Ausnahmen

NotSupportedException

Das Betriebssystem ist nicht Windows NT oder höher.

- oder -

Der Socket ist nicht mit einem Remotehost verbunden.

ObjectDisposedException

Das Socket-Objekt wurde geschlossen.

InvalidOperationException

Das Socket-Objekt ist nicht im Blockierungsmodus und kann diesen synchronen Aufruf nicht annehmen.

FileNotFoundException

Die Datei fileName wurde nicht gefunden.

SocketException

Fehler beim Versuch, auf den Socket zuzugreifen.

Beispiele

Im folgenden Codebeispiel wird ein Socket erstellt und verbunden. Die Datei "test.txt" befindet sich im Stammverzeichnis des lokalen Computers. In diesem Beispiel erstellen wir einen Vorabpuffer und Postbuffer von Daten und senden sie an den Remotehost mit der Datei. Die Standardeinstellung TransmitFileOptions wird verwendet.

// 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();

Hinweise

Diese Überladung erfordert den Namen der Datei, die Sie senden möchten, und eine bitweise Kombination von TransmitFileOptions Werten. Der preBuffer Parameter enthält alle Daten, die Sie der Datei vorangehen möchten. postBuffer enthält Daten, die Sie der Datei folgen möchten. Wenn fileName es sich im aktuellen Arbeitsverzeichnis befindet, kann es nur mit dem Namen der Datei identifiziert werden. Andernfalls muss der vollständige Pfad und der Name der Datei angegeben werden. Wildcards ("..\\myfile.txt") und UNC-Freigabenamen ("\\\\shared directory\\myfile.txt") werden unterstützt.

Der flags Parameter stellt den Window Sockets-Dienstanbieter zusätzliche Informationen zur Dateiübertragung bereit. Weitere Informationen zum Verwenden dieses Typs finden Sie unter TransmitFileOptions.

Diese Methode verwendet die TransmitFile in der Windows Sockets 2-API gefundene Funktion. Weitere Informationen zu der Funktion und ihren Flags finden Sie in der TransmitFile Dokumentation zu Windows Sockets.

SendFilesendet synchron eine Datei an den Remotehost, der in der oder Accept der Connect Methode angegeben ist. SendFile kann sowohl für verbindungsorientierte als auch für verbindungslose Protokolle verwendet werden.

Wenn Sie ein verbindungsloses Protokoll verwenden, müssen Sie vor dem Aufrufen dieser Methode aufrufen Connect . Andernfalls SendFile wird ein SocketExceptionFehler ausgelöst. Wenn Sie ein verbindungsorientiertes Protokoll verwenden, müssen Sie entweder Connect eine Remotehostverbindung einrichten oder Accept eine eingehende Verbindung akzeptieren.

Wenn Sie ein verbindungsorientiertes Protokoll verwenden, wird blockiert, SendFile bis die gesamte Datei gesendet wird. Im Nichtblockingmodus kann es erfolgreich abgeschlossen werden, SendFile bevor die gesamte Datei gesendet wurde. Es gibt keine Garantie, dass die von Ihnen gesendeten Daten sofort im Netzwerk angezeigt werden. Um die Netzwerkeffizienz zu erhöhen, kann das zugrunde liegende System die Übertragung verzögern, bis eine erhebliche Menge ausgehender Daten erfasst wird. Ein erfolgreicher Abschluss der SendFile Methode bedeutet, dass das zugrunde liegende System Platz zum Puffern Ihrer Daten für eine Netzwerknachricht hatte.

Hinweis

Wenn Sie erhalten eine SocketException, verwenden die SocketException.ErrorCode Eigenschaft, um den spezifischen Fehlercode zu erhalten. Nachdem Sie diesen Code abgerufen haben, finden Sie in der Dokumentation zu Windows Sockets Version 2-API-Fehlercode für eine detaillierte Beschreibung des Fehlers.

Hinweis

Dieser Member gibt Ablaufverfolgungsinformationen aus, wenn Sie die Netzwerkablaufverfolgung in der Anwendung aktivieren. Weitere Informationen finden Sie unter "Netzwerkablaufverfolgung" im .NET Framework.

Gilt für

SendFile(String, ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, TransmitFileOptions)

Sendet die Datei fileName und puffert Daten mit dem angegebenen TransmitFileOptions-Wert in einem verbundenen Socket-Objekt.

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

Parameter

fileName
String

Ein String, der den Pfad und Namen der Datei enthält, die gesendet werden soll. Dieser Parameter kann null sein.

preBuffer
ReadOnlySpan<Byte>

Eine ReadOnlySpan<T> , die Daten enthält, die gesendet werden sollen, bevor die Datei gesendet wird. Dieser Puffer kann leer sein.

postBuffer
ReadOnlySpan<Byte>

Eine ReadOnlySpan<T> , die Daten enthält, die nach dem Senden der Datei gesendet werden sollen. Dieser Puffer kann leer sein.

flags
TransmitFileOptions

Mindestens ein TransmitFileOptions-Wert.

Ausnahmen

ObjectDisposedException

Das Socket-Objekt wurde geschlossen.

NotSupportedException

Das Socket Objekt ist nicht mit einem Remotehost verbunden.

InvalidOperationException

Das Socket-Objekt ist nicht im Blockierungsmodus und kann diesen synchronen Aufruf nicht annehmen.

FileNotFoundException

Die Datei fileName wurde nicht gefunden.

SocketException

Fehler beim Versuch, auf den Socket zuzugreifen.

Gilt für