/************************************************************************* * * $RCSfile: XBlob.idl,v $ * * $Revision: 1.2 $ * * last change: $Author: mi $ $Date: 2000-11-06 13:16:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_sdbc_XBlob_idl__ #define __com_sun_star_sdbc_XBlob_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif module com { module sun { module star { module io { interface XInputStream; };};};}; #ifndef __com_sun_star_sdbc_SQLException_idl__ #include #endif module com { module sun { module star { module sdbc { // DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XBlob /** 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.

*/ [ uik(D6B6023A-9067-11d3-9EE00010-5AD7A5C4), ident("XBlob", 1.0) ] 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 BLOB value designated by this Blob object. */ 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 BLOB value that this Blob object designates. The byte array contains up to length consecutive bytes starting at position pos. @param pos is the ordinal position of the first byte in the BLOB 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 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. */ sequence getBytes([in]hyper pos, [in]long length) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBinaryStream /** retrieves the BLOB designated by this Blob instance as a stream. */ com::sun::star::io::XInputStream getBinaryStream() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::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. */ hyper position([in]sequence pattern, [in]hyper start) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::positionOfBlob /** determines the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start. */ hyper positionOfBlob([in]XBlob pattern,[in] hyper start) raises (SQLException); }; //============================================================================= }; }; }; }; /*=========================================================================== $Log: not supported by cvs2svn $ Revision 1.1.1.1 2000/09/18 23:35:41 hjs initial import Revision 1.8 2000/09/11 11:52:42 mi documentation merged from XML Revision 1.6 2000/02/07 11:24:52 mi zu #70728# missing documentation marked Revision 1.5 2000/01/14 11:09:11 mi XML syntax error in documentation Revision 1.4 1999/12/20 16:11:35 dg #70278# changes in API Revision 1.3 1999/12/13 13:47:54 dg #70278# XSQLErrorBroadcaster removed Revision 1.2 1999/11/24 11:33:26 dg chk includes Revision 1.1 1999/11/24 08:41:04 dg new StarDataBaseConnectivity ===========================================================================*/ #endif