Show: Delphi C++
Display Preferences

Data.DB.TDataSet.CreateBlobStream

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CreateBlobStream(Field: TField; Mode: TBlobStreamMode): TStream; virtual;

C++

virtual System::Classes::TStream* __fastcall CreateBlobStream(TField* Field, TBlobStreamMode Mode);

Properties

Type Visibility Source Unit Parent
function public
Data.DB.pas
Data.DB.hpp
Data.DB TDataSet

Description

Provides the interface for a method that creates a blob stream for a Binary large object (BLOB) field in the dataset.

Call CreateBlobStream to obtain a stream for reading and writing the value of the field specified by the Field parameter. The Mode parameter indicates whether the stream will be used for reading the value of the field (bmRead), writing the value of the field (bmWrite), or modifying the value of the field (bmReadWrite).

Blob streams are created in a specific mode for a specific field on a specific record. Applications create a new blob stream every time the record in the dataset changes: do not reuse an existing blob stream.

As implemented in TDataSet, CreateBlobStream always returns nil (Delphi) or NULL (C++). Descendants of TDataSet override this method to create the TStream descendant that reads and writes BLOB data in the format that dataset type uses to store BLOB fields.

Tip: It is preferable to call CreateBlobStream rather than creating a blob stream directly in code. This ensures that the stream is appropriate to the dataset, and may also ensure that datasets that do not always store BLOB data in memory fetch the blob data before creating the stream.

See Also

Code Examples

Personal tools
In Other Languages
Previous Versions
Assistance