<html> <head> <title>Interface XBlob</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XBlob-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdbc</a> :: </p> </td> </tr> <tr> <td class="title">interface XBlob</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is the representation (mapping) of an SQL <i> BLOB </i> . </dd> <dd><p> 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. </p> <p> Methods in the interfaces <a href="XResultSet.html">XResultSet</a> , and <a href="XPreparedStatement.html">XPreparedStatement</a> , 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> </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#length">length</a></td> <td class="imsum_right">returns the number of bytes in the <i> BLOB </i> value designated by this <code>Blob</code> object. </td> </tr> <tr> <td class="imsum_left"><a href="#getBytes">getBytes</a></td> <td class="imsum_right">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>. </td> </tr> <tr> <td class="imsum_left"><a href="#getBinaryStream">getBinaryStream</a></td> <td class="imsum_right">retrieves the <i> BLOB </i> designated by this <code>Blob</code> instance as a stream. </td> </tr> <tr> <td class="imsum_left"><a href="#position">position</a></td> <td class="imsum_right">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> . </td> </tr> <tr> <td class="imsum_left"><a href="#positionOfBlob">positionOfBlob</a></td> <td class="imsum_right">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> . </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="length" class="membertitle">length</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">hyper</td> </tr> <tr> <td valign="top"><b>length</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the number of bytes in the <i> BLOB </i> value designated by this <code>Blob</code> object. </dd> <dt><b>Returns</b></dt> <dd>the length </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBytes" class="membertitle">getBytes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< byte ></td> </tr> <tr> <td valign="top"><b>getBytes</b>(</td> <td valign="top">[in] hyper</td> <td valign="bottom"> pos,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> length )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>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>. </dd> <dt><b>Parameter pos</b></dt> <dd>is the ordinal position of the first byte in the <i> BLOB </i> value to be extracted; the first byte is at position 1. </dd> <dt><b>Parameter length</b></dt> <dd>is the number of consecutive bytes to be copied. </dd> <dt><b>Returns</b></dt> <dd>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> . </dd> <dt><b>Throws</b></dt> <dd>SQLException if there is an error accessing the <i> BLOB </i> . </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBinaryStream" class="membertitle">getBinaryStream</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td> </tr> <tr> <td valign="top"><b>getBinaryStream</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the <i> BLOB </i> designated by this <code>Blob</code> instance as a stream. </dd> <dt><b>Returns</b></dt> <dd>the stream </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="position" class="membertitle">position</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">hyper</td> </tr> <tr> <td valign="top"><b>position</b>(</td> <td valign="top">[in] sequence< byte ></td> <td valign="bottom"> pattern,</td> </tr> <tr> <td/><td valign="top">[in] hyper</td> <td valign="bottom"> start )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>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> . </dd> <dt><b>Parameter pattern</b></dt> <dd>the pattern to search </dd> <dt><b>Returns</b></dt> <dd>the position </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="positionOfBlob" class="membertitle">positionOfBlob</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">hyper</td> </tr> <tr> <td valign="top"><b>positionOfBlob</b>(</td> <td valign="top">[in] <a href="XBlob.html">XBlob</a></td> <td valign="bottom"> pattern,</td> </tr> <tr> <td/><td valign="top">[in] hyper</td> <td valign="bottom"> start )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>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> . </dd> <dt><b>Parameter pattern</b></dt> <dd>the pattern to search </dd> <dt><b>Parameter start</b></dt> <dd>position to start </dd> <dt><b>Returns</b></dt> <dd>the position </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
