Socket.BeginSendFile Methode

Quelle:

Socket.cs

Quelle:

Socket.cs

Quelle:

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

Parameter

Gibt zurück

Ein IAsyncResult-Objekt, das den asynchronen Sendevorgang darstellt.

Ausnahmen

Hinweise

Diese Überladung sendet die Datei fileName über den Socket. Wenn fileName sich das lokale Verzeichnis befindet, kann es nur mit dem Namen der Datei identifiziert werden. Andernfalls müssen 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.

Sie können einen Rückruf übergeben, der implementiert wird, BeginSendFile um über den Abschluss des Vorgangs AsyncCallback benachrichtigt zu werden. Beachten Sie, dass der Rückruf während des Aufrufs BeginSendFilevon inline ausgeführt wird, wenn der zugrunde liegende Netzwerkstapel den Vorgang synchron abschließt. In diesem Fall wird die CompletedSynchronously Eigenschaft für die zurückgegebene IAsyncResult auf true festgelegt, um anzugeben, dass die Methode synchron abgeschlossen wurde. Verwenden Sie die AsyncState -Eigenschaft von, IAsyncResult um das an die -Methode übergebene Zustandsobjekt BeginSendFile abzurufen.

Der BeginSendFile Vorgang muss durch Aufrufen der EndSendFile -Methode abgeschlossen werden. In der Regel wird die -Methode vom AsyncCallback Delegaten aufgerufen. EndSendFile blockiert den aufrufenden Thread, bis der Vorgang abgeschlossen ist.

Obwohl für verbindungsorientierte Protokolle vorgesehen, BeginSendFile funktioniert sie auch für verbindungslose Protokolle, vorausgesetzt, Sie rufen zuerst die Connect -Methode oder auf, BeginConnect um einen Standard-Remotehost einzurichten. Bei verbindungslosen Protokollen müssen Sie sicherstellen, dass die Größe Ihrer Datei die maximale Paketgröße des zugrunde liegenden Dienstanbieters nicht überschreitet. Wenn dies der Fall ist, wird das Datagramm nicht gesendet und BeginSendFile löst eine Ausnahme aus SocketException .

Quelle:

Socket.cs

Quelle:

Socket.cs

Quelle:

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

Parameter

Gibt zurück

Ein IAsyncResult-Objekt, das den asynchronen Vorgang darstellt.

Ausnahmen

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 der Datei vorangestellt werden sollen. postBuffer enthält Daten, die Sie der Datei folgen möchten. Wenn fileName sich das lokale Verzeichnis befindet, kann es nur mit dem Namen der Datei identifiziert werden. Andernfalls müssen 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.

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

Sie können einen Rückruf übergeben, der implementiert wird, BeginSendFile um über den Abschluss des Vorgangs AsyncCallback benachrichtigt zu werden. Beachten Sie, dass der Rückruf während des Aufrufs BeginSendFilevon inline ausgeführt wird, wenn der zugrunde liegende Netzwerkstapel den Vorgang synchron abschließt. In diesem Fall wird die CompletedSynchronously Eigenschaft für die zurückgegebene IAsyncResult auf true festgelegt, um anzugeben, dass die Methode synchron abgeschlossen wurde. Verwenden Sie die AsyncState -Eigenschaft von, IAsyncResult um das an die -Methode übergebene Zustandsobjekt BeginSendFile abzurufen.

Der BeginSendFile Vorgang muss durch Aufrufen der EndSendFile -Methode abgeschlossen werden. In der Regel wird die -Methode vom bereitgestellten AsyncCallback Delegat aufgerufen. EndSendFile blockiert den aufrufenden Thread, bis der Vorgang abgeschlossen ist.

Obwohl für verbindungsorientierte Protokolle vorgesehen, BeginSendFile funktioniert sie auch für verbindungslose Protokolle, vorausgesetzt, Sie rufen zuerst die Connect -Methode oder auf, BeginConnect um einen Standard-Remotehost einzurichten. Bei verbindungslosen Protokollen müssen Sie sicherstellen, dass die Größe Ihrer Datei die maximale Paketgröße des zugrunde liegenden Dienstanbieters nicht überschreitet. Wenn dies der Fall ist, wird das Datagramm nicht gesendet und BeginSendFile löst eine Ausnahme aus SocketException .