Home  |  Delphi .net Home  |  System.IO.FileStream  |  EndWrite Method
EndWrite  
Method  
Wait for an asynchronous write to complete
FileStream Class
System.IO NameSpace
CF1.  Procedure EndWrite ( AsyncResult : IAsyncResult; ) ;
CF : Methods with this mark are Compact Framework Compatible
Description
Normally, you would allow the callback method of an asynchronous write to be called. If you need to wait until this happens in the main thread of operation, then call EndWrite.
 
The AsynResult parameter should be supplied with the value returned by the BeginWrite you want to wait for.
Notes
The callback method will be called asynchronously to the main thread - see the example for the effect of this.
Microsoft MSDN Links
System.IO
System.IO.FileStream
 
 
A simple example
// Full Unit code.
// -------------------------------------------------------------
// Create a new WinForm application, double click the form to
// create an OnLoad event, and then replace the WinForm unit
// with this text.
 
unit WinForm;
 
interface
 
uses
  System.Drawing, System.Collections, System.ComponentModel,
System.Windows.Forms, System.Data;
 
type
  TWinForm = class(System.Windows.Forms.Form)
  \{REGION 'Designer Managed Code'\} // Note that REGION and ENREGION should be prefixed by a dollar sign
  strict private
    ///
    /// Required designer variable.
    ///

    Components: System.ComponentModel.Container;
    ///
    /// Required method for Designer support - do not modify
    /// the contents of this method with the code editor.
    ///

    procedure InitializeComponent;
    procedure TWinForm_Load(sender: System.Object; e: System.EventArgs);
  {ENDREGION}
  strict protected
    ///
    /// Clean up any resources being used.
    ///

    procedure Dispose(Disposing: Boolean); override;
  private
    { Private Declarations }
  public
    constructor Create;
  end;
 
  [assembly: RuntimeRequiredAttribute(TypeOf(TWinForm))]
 
implementation
 
\{REGION 'Windows Form Designer generated code'\}
///
/// Required method for Designer support -- do not modify
/// the contents of this method with the code editor.
///

 
 
procedure TWinForm.InitializeComponent;
begin
  //
  // TWinForm
  //
  Self.AutoScaleBaseSize := System.Drawing.Size.Create(5, 13);
  Self.ClientSize := System.Drawing.Size.Create(292, 266);
  Self.Name := 'TWinForm';
  Self.Text := 'WinForm';
  Include(Self.Load, Self.TWinForm_Load);
end;
{ENDREGION}
 
procedure TWinForm.Dispose(Disposing: Boolean);
begin
  if Disposing then
  begin
    if Components <> nil then
      Components.Dispose();
  end;
  inherited Dispose(Disposing);
end;
 
constructor TWinForm.Create;
begin
  inherited Create;
  //
  // Required for Windows Form Designer support
  //
  InitializeComponent;
  //
  // TODO: Add any constructor code after InitializeComponent call
  //
end;
 
procedure TWinForm.TWinForm_Load(sender: System.Object; e: System.EventArgs);
program Project1;
{$APPTYPE CONSOLE}

uses
  System.IO,
  System.Runtime.Remoting.Messaging;

var
  Stream    : System.IO.FileStream;
  ByteArray : Array of Byte;
  ByteAsInt : Integer;
  AsyncRes  : IAsyncResult;
  Index     : Integer;

procedure WriteDone(AsyncResult : IAsyncResult);
var
  Index : Integer;
begin
  Console.WriteLine('Write is finished :');
  Console.WriteLine;
end;

begin
  // Create our File Stream
  Stream := System.IO.FileStream.Create('C:\DelphiBasics.txt', FileMode.Create);

  // Create our byte array
  SetLength(ByteArray, 10);

  // And fill it
  ByteArray[0] := 65; // Ord(65) = 'A'
  ByteArray[1] := 66;
  ByteArray[2] := 67;
  ByteArray[3] := 68;
  ByteArray[4] := 69;
  ByteArray[5] := 70;
  ByteArray[6] := 71;
  ByteArray[7] := 72;
  ByteArray[8] := 73;
  ByteArray[9] := 74;

  // Write to the stream from the array asynchronously
  AsyncRes := Stream.BeginWrite(ByteArray, 0, 10, WriteDone, TObject.Create);

  // Wait for the read to end
  Console.WriteLine;
  Console.WriteLine('Waiting in main thread for write to complete');
  Console.WriteLine;

  Stream.EndWrite(AsyncRes);

  // Display the stream contents
  Stream.Seek(0, SeekOrigin.Begin);
  ByteAsInt := Stream.ReadByte;

  while ByteAsInt > 0 do
  begin
    Console.WriteLine(Char(ByteAsInt));
    ByteAsInt := Stream.ReadByte;
  end;

  // Close the file stream
  Stream.Close;

  Console.Readline;
end.
 
end.
Hide full unit code
  
  Waiting in main thread for write to complete
  
  A
  B
  C
  D
  E
  F
  G
  Write is finished :
  
  H
  I
  J
 
 
Delphi Programming © Neil Moffatt All rights reserved.  |  Contact the author