diff options
Diffstat (limited to 'offapi/com/sun/star/sdbc/XBlob.idl')
| -rw-r--r-- | offapi/com/sun/star/sdbc/XBlob.idl | 206 |
1 files changed, 163 insertions, 43 deletions
diff --git a/offapi/com/sun/star/sdbc/XBlob.idl b/offapi/com/sun/star/sdbc/XBlob.idl index 1f949ace6572..2ed9694a3e3b 100644 --- a/offapi/com/sun/star/sdbc/XBlob.idl +++ b/offapi/com/sun/star/sdbc/XBlob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBlob.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,61 +77,135 @@ interface XInputStream; // DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XBlob -/** is the representation (mapping) of an SQL <i>BLOB</i>. - +/** is the representation (mapping) of an SQL + <i> + BLOB + </i> + . <p> - A SQL <i>BLOB</i> is a built-in type that stores a + A SQL + <i> + BLOB + </i> + 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 <i>BLOB</i> using a - SQL <code>locator(BLOB)</code>, which means that a <code>Blob</code> - object contains a logical pointer to the SQL <i>BLOB</i> data rather - than the data itself. - <br> - A <code>Blob</code> object is valid for the duration of the - transaction in which is was created. + The driver implements + <i> + BLOB + </i> + using a + SQL + <code>locator(BLOB)</code> + , which means that a + <code>Blob</code> + object contains a logical pointer to the SQL + <i> + BLOB + </i> + data rather than the data itself. + <br/> + A + <code>Blob</code> + object is valid for the duration of the transaction in which is was created. </p> - <p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>, - and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as - <code>getBlob</code> and <code>setBlob</code> allow a programmer to - access the SQL <i>BLOB</i>.<br> - The <code>Blob</code> interface provides methods for getting the - length of a SQL <i>BLOB</i> (Binary Large Object) value, - for materializing a <i>BLOB</i> value on the client and for - determining the position of a pattern of bytes within a - <i>BLOB</i> value.</p> + <p> + Methods in the interfaces + <type scope="com::sun::star::sdbc">XResultSet</type> + , + and + <type scope="com::sun::star::sdbc">XPreparedStatement</type> + , such as + <code>getBlob</code> + and + <code>setBlob</code> + allow a programmer to access the SQL + <i> + BLOB + </i> + . + <br/> + The + <code>Blob</code> + interface provides methods for getting the length of a SQL + <i> + BLOB + </i> + (Binary Large Object) value, for materializing a + <i> + BLOB + </i> + value on the client and for determining the position of a pattern of bytes within a + <i> + BLOB + </i> + value. + </p> */ interface XBlob: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::length - /** returns the number of bytes in the <i>BLOB</i> value - designated by this <code>Blob</code> object. + /** returns the number of bytes in the + <i> + BLOB + </i> + value + designated by this + <code>Blob</code> + object. + @returns + the length + @throws SQLException + if a database access error occurs. */ hyper length() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBytes - /** returns as an array of bytes part or all of the <i>BLOB</i> - value that this <code>Blob</code> object designates. The byte - array contains up to <code>length</code> consecutive bytes - starting at position <code>pos</code>. + /** returns as an array of bytes part or all of the + <i> + BLOB + </i> + value that this + <code>Blob</code> + object designates. The byte + array contains up to + <code>length</code> + consecutive bytes + starting at position + <code>pos</code>. @param pos is the ordinal position of the first byte in the - <i>BLOB</i> value to be extracted; the first byte is at + <i> + BLOB + </i> + value to be extracted; the first byte is at position 1. @param length is the number of consecutive bytes to be copied. @returns - a byte array containing up to <code>length</code> - consecutive bytes from the <i>BLOB</i> value designated - by this <code>Blob</code> object, starting with the - byte at position <code>pos</code>. + a byte array containing up to + <code>length</code> + consecutive bytes from the + <i> + BLOB + </i> + value designated + by this + <code>Blob</code> + object, starting with the byte at position + <code>pos</code> + . @throws SQLException - if there is an error accessing the <i>BLOB</i>. + if there is an error accessing the + <i> + BLOB + </i> + . */ sequence<byte> getBytes([in]hyper pos, [in]long length) raises (SQLException); @@ -139,8 +213,17 @@ interface XBlob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBinaryStream - /** retrieves the <i>BLOB</i> designated by this - <code>Blob</code> instance as a stream. + /** retrieves the + <i> + BLOB + </i> + designated by this + <code>Blob</code> + instance as a stream. + @returns + the stream + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getBinaryStream() raises (SQLException); @@ -148,10 +231,25 @@ interface XBlob: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::position /** determines the byte position at which the specified byte - <code>pattern</code> begins within the <i>BLOB</i> - value that this <code>Blob</code> object represents. The - search for <code>pattern</code> begins at position - <code>start</code>. + <code>pattern</code> + begins within the + <i> + BLOB + </i> + value that this + <code>Blob</code> + object represents. The + search for + <code>pattern</code> + begins at position + <code>start</code> + . + @param pattern + the pattern to search + @returns + the position + @throws SQLException + if a database access error occurs. */ hyper position([in]sequence<byte> pattern, [in]hyper start) raises (SQLException); @@ -159,10 +257,26 @@ interface XBlob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::positionOfBlob - /** determines the byte position in the <i>BLOB</i> value - designated by this <code>Blob</code> object at which - <code>pattern</code> begins. The search begins at position - <code>start</code>. + /** determines the byte position in the + <i> + BLOB + </i> + value + designated by this + <code>Blob</code> + object at which + <code>pattern</code> + begins. The search begins at position + <code>start</code> + . + @param pattern + the pattern to search + @param start + position to start + @returns + the position + @throws SQLException + if a database access error occurs. */ hyper positionOfBlob([in]XBlob pattern,[in] hyper start) raises (SQLException); @@ -174,6 +288,12 @@ interface XBlob: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api |