interface XBlob in module com::sun::star::sdbc::

(Global Index)

Syntax

interface XBlob : com::sun::star::uno::XInterface ;

Description

is the representation (mapping) of an SQL BLOB .

A SQL BLOB is a built-in type that stores a Binary Large Object as a column value in a row of a database table. The driver implements BLOB using a SQL locator(BLOB) , which means that a Blob object contains a logical pointer to the SQL BLOB data rather than the data itself.
A Blob object is valid for the duration of the transaction in which is was created.

Methods in the interfaces XResultSet , and XPreparedStatement , such as getBlob and setBlob allow a programmer to access the SQL BLOB .
The Blob interface provides methods for getting the length of a SQL BLOB (Binary Large Object) value, for materializing a BLOB value on the client and for determining the position of a pattern of bytes within a BLOB value.

Method Summary

length returns the number of bytes in the BLOB value designated by this Blob object.

getBytes returns as an array of bytes part or all of the BLOB value that this Blob object designates. The byte array contains up to length consecutive bytes starting at position pos .

getBinaryStream retrieves the BLOB designated by this Blob instance as a stream.

position determines the byte position at which the specified byte pattern begins within the BLOB value that this Blob object represents. The search for pattern begins at position start .

positionOfBlob determines the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start .

Method Details



length

Syntax

hyper length ();
raises ( com::sun::star::sdbc::SQLException );

Description

returns the number of bytes in the BLOB value designated by this Blob object.

Returns

the length

Throws

SQLException if a database access error occurs.

getBytes

Syntax

sequence< byte > getBytes (
hyper pos,
long length )
raises ( com::sun::star::sdbc::SQLException );

Description

returns as an array of bytes part or all of the BLOB value that this Blob object designates. The byte array contains up to length consecutive bytes starting at position pos .

Parameter pos

is the ordinal position of the first byte in the BLOB value to be extracted; the first byte is at position 1.

Parameter length

is the number of consecutive bytes to be copied.

Returns

a byte array containing up to length consecutive bytes from the BLOB value designated by this Blob object, starting with the byte at position pos .

Throws

SQLException if there is an error accessing the BLOB .

getBinaryStream

Syntax

com::sun::star::io::XInputStream getBinaryStream ();
raises ( com::sun::star::sdbc::SQLException );

Description

retrieves the BLOB designated by this Blob instance as a stream.

Returns

the stream

Throws

SQLException if a database access error occurs.

position

Syntax

hyper position (
sequence< byte > pattern,
hyper start )
raises ( com::sun::star::sdbc::SQLException );

Description

determines the byte position at which the specified byte pattern begins within the BLOB value that this Blob object represents. The search for pattern begins at position start .

Parameter pattern

the pattern to search

Returns

the position

Throws

SQLException if a database access error occurs.

positionOfBlob

Syntax

hyper positionOfBlob (
com::sun::star::sdbc::XBlob pattern,
hyper start )
raises ( com::sun::star::sdbc::SQLException );

Description

determines the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start .

Parameter pattern

the pattern to search

Parameter start

position to start

Returns

the position

Throws

SQLException if a database access error occurs.
Top of Page