This interface is used when it is required to
Definition at line 269 of file SQLDBC.h.
SQLDBC_Retcode SQLDBC::SQLDBC_LOB::putData | ( | void * | paramAddr, | |
SQLDBC_Length * | paramLengthIndicator | |||
) |
Put data into a LONG value that is referenced by this LOB object.
paramAddr | Pointer to the data which is to be assigned to the LONG value. The type of the data | |
paramLengthIndicator | [in] Pointer to parameter length or indicator. |
SQLDBC_Retcode SQLDBC::SQLDBC_LOB::close | ( | ) |
Closes the LOB object.
No further actions can take place.
SQLDBC_Retcode SQLDBC::SQLDBC_LOB::getData | ( | void * | paramAddr, | |
SQLDBC_Length * | LengthIndicator, | |||
const SQLDBC_Length | Size, | |||
const SQLDBC_Bool | Terminate = SQLDBC_TRUE | |||
) |
Retrieves the content of the specified LONG column.
The specified LONG column value is converted to the given length and to the output parameter buffer pointed to paramAddr. Repeated calls of this method proceed with reading the LONG value, as long as there is data to read available.
paramAddr | A pointer to the parameters output buffer. | |
LengthIndicator | [out] Pointer to a variable that stores the column length or the indicator value SQLDBC_NULL_DATA if the column contains the NULL value. For character data it contains on success the number of bytes copied to the buffer, except the number of bytes necessary for the zero-terminator, if the Terminate flag was set. If the source string exceeds the Size value SQLDBC_DATA_TRUNC will be returned and LengthIndicator is set to the number of bytes (except the terminator bytes) needed to copy without truncation. | |
Size | [in] Length of the parameter buffer in bytes. For character data the Size argument must be large enough to store the terminator byte(s) if the Terminate flag is set. | |
Terminate | [in] Specifies that the output buffer must be finished with a C-style zero-terminator. The Terminate flag works only for the host variable type character (ASCII, UCS2 or UTF8). As a default, all character data is zero-terminated. |
SQLDBC_Retcode SQLDBC::SQLDBC_LOB::getData | ( | void * | paramAddr, | |
SQLDBC_Length * | LengthIndicator, | |||
const SQLDBC_Length | Size, | |||
const SQLDBC_Length | position, | |||
const SQLDBC_Bool | Terminate = SQLDBC_TRUE | |||
) |
Retrieves the content of the specified LONG column.
The specified LONG column value is converted to the given length and to the output parameter buffer pointed to paramAddr. After the operation, the internal position is the start position plus the number of characters that have been read.
paramAddr | A pointer to the parameters output buffer. | |
LengthIndicator | [out] Pointer to a variable that stores the column length or the indicator value SQLDBC_NULL_DATA if the column contains the NULL value. For character data it contains on success the number of bytes copied to the buffer, except the number of bytes necessary for the zero-terminator, if the Terminate flag was set. If the source string exceeds the Size value SQLDBC_DATA_TRUNC will be returned and LengthIndicator is set to the number of bytes (except the terminator bytes) needed to copy without truncation. | |
Size | [in] Length of the parameter buffer in bytes. For character data the Size argument must be large enough to store the terminator byte(s) if the Terminate flag is set. | |
position | The start position from where to read. | |
Terminate | [in] Specifies that the output buffer must be finished with a C-style zero-terminator. The Terminate flag works only for the host variable type character (ASCII, UCS2 or UTF8). As a default, all character data is zero-terminated. |
SQLDBC_Length SQLDBC::SQLDBC_LOB::getLength | ( | ) |
Retrieves the length of this LOB in the database.
The length is returned in chars. The LOB must be opened for reading to retrieve this value.
SQLDBC_Length SQLDBC::SQLDBC_LOB::getPosition | ( | ) |
Get the current read/write position.
SQLDBC_Length SQLDBC::SQLDBC_LOB::getPreferredDataSize | ( | ) |
Retrieves the optimal size of data for reading or writing (the maximum size that can be transferred with one call to the database server).
An application may use this to optimize the communication, by using buffers that are multiples of the preferred size.