| LibreOffice
    LibreOffice 24.8 SDK API Reference | 
is the mapping for the SQL CLOB type.  
 More...
import "XClob.idl";
 
  
| Public Member Functions | |
| hyper | length () raises (SQLException) | 
| returns the number of characters in the CLOBvalue designated by thisClobobject. | |
| string | getSubString ([in]hyper pos, [in]long length) raises (SQLException) | 
| returns a copy of the specified substring in the Clobvalue designated by thisClobobject. | |
| com::sun::star::io::XInputStream | getCharacterStream () raises (SQLException) | 
| gets the Clobcontents as a stream. | |
| hyper | position ([in]string searchstr, [in]long start) raises (SQLException) | 
| determines the character position at which the specified substring searchstrappears in theClob. | |
| hyper | positionOfClob ([in]XClob pattern, [in]hyper start) raises (SQLException) | 
| determines the position at which the specified Clobobjectpatternappears in thisClobobject. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
is the mapping for the SQL CLOB type. 
A SQL CLOB is a built-in type that stores a Character Large Object as a column value in a row of a database table. The driver implements a Clob object using a SQL locator(CLOB) , which means that a Clob object contains a logical pointer to the SQL CLOB data rather than the data itself. A Clob object is valid for the duration of the transaction in which it was created. 
The Clob interface provides methods for getting the length of a SQL CLOB (Character Large Object) value, for materializing a CLOB value on the client, and for searching for a substring or CLOB object within a CLOB value. 
Methods in the interfaces com::sun::star::sdbc::XResultSet , and com::sun::star::sdbc::XPreparedStatement , such as getClob and setClob allow a programmer to access the SQL CLOB. 
| com::sun::star::io::XInputStream getCharacterStream | ( | ) | ||||
| raises | ( | SQLException ) | ||||
gets the Clob contents as a stream. 
| SQLException | if a database access error occurs. | 
| string getSubString | ( | [in] hyper | pos, | |||
| [in] long | length ) | |||||
| raises | ( | SQLException ) | ||||
returns a copy of the specified substring in the Clob value designated by this Clob object. 
The substring begins at position pos and has up to length consecutive characters. 
| pos | the starting position, 1-based | 
| length | the length of the substring | 
| SQLException | if a database access error occurs. | 
| hyper length | ( | ) | ||||
| raises | ( | SQLException ) | ||||
returns the number of characters in the CLOB value designated by this Clob object. 
| SQLException | if a database access error occurs. | 
| hyper position | ( | [in] string | searchstr, | |||
| [in] long | start ) | |||||
| raises | ( | SQLException ) | ||||
determines the character position at which the specified substring searchstr appears in the Clob. 
The search begins at position start.
| searchstr | the string to search | 
| start | the starting position | 
| SQLException | if a database access error occurs. | 
| hyper positionOfClob | ( | [in] XClob | pattern, | |||
| [in] hyper | start ) | |||||
| raises | ( | SQLException ) | ||||
determines the position at which the specified Clob object pattern appears in this Clob object. 
The search begins at position start. 
| pattern | the CLOB to search | 
| start | the starting position | 
| SQLException | if a database access error occurs. |