wxSQLite3  4.4.3
Public Member Functions | List of all members
wxSQLite3Blob Class Reference

Represents a SQLite BLOB handle. More...

#include <wxsqlite3.h>

Public Member Functions

 wxSQLite3Blob ()
 Constructor. More...
 
 wxSQLite3Blob (const wxSQLite3Blob &blob)
 Copy constructor. More...
 
wxSQLite3Bloboperator= (const wxSQLite3Blob &blob)
 Assignment constructor. More...
 
 wxSQLite3Blob (wxSQLite3DatabaseReference *m_db, wxSQLite3BlobReference *blobHandle, bool writable)
 Constructor (internal use only) More...
 
virtual ~wxSQLite3Blob ()
 Destructor. More...
 
wxMemoryBuffer & Read (wxMemoryBuffer &blobValue, int length, int offset) const
 Read partial BLOB value. More...
 
void Write (const wxMemoryBuffer &blobValue, int offset)
 Write partial BLOB value. More...
 
bool IsOk () const
 Check whether the BLOB handle is correctly initialized. More...
 
bool IsReadOnly () const
 Check whether the BLOB handle is read only. More...
 
int GetSize () const
 Get the size of the associated BLOB. More...
 
void Rebind (wxLongLong rowid)
 Rebind the associated BLOB to a new row. More...
 
void Finalize ()
 Finalize the BLOB. More...
 

Detailed Description

Represents a SQLite BLOB handle.

Constructor & Destructor Documentation

◆ wxSQLite3Blob() [1/3]

wxSQLite3Blob::wxSQLite3Blob ( )

Constructor.

◆ wxSQLite3Blob() [2/3]

wxSQLite3Blob::wxSQLite3Blob ( const wxSQLite3Blob blob)

Copy constructor.

◆ wxSQLite3Blob() [3/3]

wxSQLite3Blob::wxSQLite3Blob ( wxSQLite3DatabaseReference m_db,
wxSQLite3BlobReference blobHandle,
bool  writable 
)

Constructor (internal use only)

◆ ~wxSQLite3Blob()

wxSQLite3Blob::~wxSQLite3Blob ( )
virtual

Destructor.

Member Function Documentation

◆ Finalize()

void wxSQLite3Blob::Finalize ( )

Finalize the BLOB.

◆ GetSize()

int wxSQLite3Blob::GetSize ( ) const

Get the size of the associated BLOB.

Returns
the BLOB size

◆ IsOk()

bool wxSQLite3Blob::IsOk ( ) const

Check whether the BLOB handle is correctly initialized.

Returns
TRUE if the BLOB handle is correctly initialized, FALSE otherwise

◆ IsReadOnly()

bool wxSQLite3Blob::IsReadOnly ( ) const

Check whether the BLOB handle is read only.

Returns
TRUE if the BLOB handle is readonly, FALSE otherweis

◆ operator=()

wxSQLite3Blob & wxSQLite3Blob::operator= ( const wxSQLite3Blob blob)

Assignment constructor.

◆ Read()

wxMemoryBuffer & wxSQLite3Blob::Read ( wxMemoryBuffer &  blobValue,
int  length,
int  offset 
) const

Read partial BLOB value.

Parameters
blobValuememory buffer receiving the partial content of the BLOB
lengthlength of BLOB content to be read
offsetoffset within BLOB where the read starts
Returns
the address of the memory buffer

◆ Rebind()

void wxSQLite3Blob::Rebind ( wxLongLong  rowid)

Rebind the associated BLOB to a new row.

Please refer to the SQLite documentation for further information (see function sqlite3_blob_reopen)

Parameters
rowidid of the row to which the BLOB should be rebound
Since
SQLite3 version 3.7.4

◆ Write()

void wxSQLite3Blob::Write ( const wxMemoryBuffer &  blobValue,
int  offset 
)

Write partial BLOB value.

Parameters
blobValuememory buffer receiving the partial content of the BLOB
offsetoffset within BLOB where the read starts

The documentation for this class was generated from the following files: