Public Member Functions | Protected Attributes | Friends

OCIPL::OciClob Struct Reference

CLOB data holder structure. More...

#include <ocipl.h>

Inheritance diagram for OCIPL::OciClob:
Inheritance graph
[legend]
Collaboration diagram for OCIPL::OciClob:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OciClob (OciConnection &conn)
 OciClob (const OciLob &other)
ub4 write (const dvoid *bufp, ub4 buflen, ub4 offset, ub4 amount, ub2 csid=0, ub1 csfrm=SQLCS_IMPLICIT)
ub4 read (dvoid *bufp, ub4 buflen, ub4 offset, ub4 amount, ub2 csid=0, ub1 csfrm=SQLCS_IMPLICIT)
boolean operator== (const OciLob &other) const
void clear ()
void * get_ref ()
const void * get_ptr () const
ub4 get_chunk_size ()
void copy (const OciLob &src, ub4 amount, ub4 dst_offset, ub4 src_offset)
void append (const OciLob &src)
void trim (ub4 newlen=0)
ub4 erase (ub4 offset, ub4 amount)
void enable_buffering ()
void disable_buffering ()
void flush (ub4 flag=OCI_LOB_BUFFER_NOFREE)
bool is_null () const
bool is_not_null () const
const SqlIndind () const
SqlIndind ()

Protected Attributes

OciConnection_conn
OCILobLocator * _loc
SqlInd _ind

Friends

struct OciOpenLob

Detailed Description

CLOB data holder structure.

Definition at line 2219 of file ocipl.h.


Constructor & Destructor Documentation

OCIPL::OciClob::OciClob ( OciConnection conn ) [inline]

Definition at line 2221 of file ocipl.h.

: OciLob(conn) {}
OCIPL::OciClob::OciClob ( const OciLob other ) [inline]

Definition at line 2222 of file ocipl.h.

: OciLob(other) {}

Member Function Documentation

void OCIPL::OciLob::append ( const OciLob src ) [inline, inherited]

Definition at line 2080 of file ocipl.h.

References OCIPL::OciLob::_loc, and OCIPL::oci_check_error().

    {
        sword res = OCILobAppend(_conn._ctx, _conn._env._errh, _loc, src._loc);
        oci_check_error(_conn._env._errh, res);
    }

Here is the call graph for this function:

void OCIPL::OciLob::clear (  ) [inline, inherited]

Definition at line 2018 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        ub4 lobEmpty = 0;
        sword res = OCIAttrSet(_loc, OCI_DTYPE_LOB, &lobEmpty, 0, OCI_ATTR_LOBEMPTY, _conn._env._errh);
        oci_check_error(_conn._env._errh, res);
    }

Here is the call graph for this function:

void OCIPL::OciLob::copy ( const OciLob src,
ub4  amount,
ub4  dst_offset,
ub4  src_offset 
) [inline, inherited]

Definition at line 2074 of file ocipl.h.

References OCIPL::OciLob::_loc, and OCIPL::oci_check_error().

    {
        sword res = OCILobCopy(_conn._ctx, _conn._env._errh, _loc, src._loc, amount, dst_offset, src_offset);
        oci_check_error(_conn._env._errh, res);
    }

Here is the call graph for this function:

void OCIPL::OciLob::disable_buffering (  ) [inline, inherited]

Definition at line 2107 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        sword res = OCILobDisableBuffering(_conn._ctx, _conn._env._errh, _loc);
        oci_check_error(_conn._env._errh, res);
    }

Here is the call graph for this function:

void OCIPL::OciLob::enable_buffering (  ) [inline, inherited]

Definition at line 2101 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        sword res = OCILobEnableBuffering(_conn._ctx, _conn._env._errh, _loc);
        oci_check_error(_conn._env._errh, res);
    }

Here is the call graph for this function:

ub4 OCIPL::OciLob::erase ( ub4  offset,
ub4  amount 
) [inline, inherited]

Definition at line 2092 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        sword res = OCILobErase(_conn._ctx, _conn._env._errh, _loc, &amount, offset);
        oci_check_error(_conn._env._errh, res);

        return amount;
    }

Here is the call graph for this function:

void OCIPL::OciLob::flush ( ub4  flag = OCI_LOB_BUFFER_NOFREE ) [inline, inherited]

Definition at line 2113 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        sword res = OCILobFlushBuffer(_conn._ctx, _conn._env._errh, _loc, flag);
        oci_check_error(_conn._env._errh, res);
    }

Here is the call graph for this function:

ub4 OCIPL::OciLob::get_chunk_size (  ) [inline, inherited]

Definition at line 2031 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        ub4 len;

        sword res = OCILobGetLength(_conn._ctx, _conn._env._errh, _loc, &len);
        oci_check_error(_conn._env._errh, res);

        return len;
    }

Here is the call graph for this function:

const void* OCIPL::OciLob::get_ptr (  ) const [inline, inherited]

Definition at line 2026 of file ocipl.h.

{return &_loc;}
void* OCIPL::OciLob::get_ref (  ) [inline, inherited]

Definition at line 2025 of file ocipl.h.

{return &_loc;}
const SqlInd& OCIPL::SqlValue::ind (  ) const [inline, inherited]
SqlInd& OCIPL::SqlValue::ind (  ) [inline, inherited]

Definition at line 1245 of file ocipl.h.

{return _ind;}
bool OCIPL::SqlValue::is_not_null (  ) const [inline, inherited]

Definition at line 1242 of file ocipl.h.

Referenced by OCIPL::SqlInt::operator int().

{return _ind.is_not_null();}

Here is the caller graph for this function:

bool OCIPL::SqlValue::is_null (  ) const [inline, inherited]

Definition at line 1241 of file ocipl.h.

{return _ind.is_null();}
boolean OCIPL::OciLob::operator== ( const OciLob other ) const [inline, inherited]

Definition at line 2007 of file ocipl.h.

References OCIPL::OciLob::_loc, and OCIPL::oci_check_error().

    {
        boolean is_equal;

        sword res = OCILobIsEqual(_conn._env, _loc, other._loc, &is_equal);

        oci_check_error(_conn._env._errh, res);

        return is_equal;
    }

Here is the call graph for this function:

ub4 OCIPL::OciClob::read ( dvoid *  bufp,
ub4  buflen,
ub4  offset,
ub4  amount,
ub2  csid = 0,
ub1  csfrm = SQLCS_IMPLICIT 
) [inline]

Definition at line 2250 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        sword res = OCILobRead(_conn._ctx, _conn._env._errh, _loc,
                      &amount, offset, bufp, buflen,
                      NULL/*dvoid* ctxp*/, NULL/*sb4 (*cbfp)(dvoid*ctxp,CONST dvoid*bufp,ub4*len,ub1*piece)*/,
                      csid, csfrm);

        oci_check_error(_conn._env._errh, res);

        return amount;
    }

Here is the call graph for this function:

void OCIPL::OciLob::trim ( ub4  newlen = 0 ) [inline, inherited]

Definition at line 2086 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        sword res = OCILobTrim(_conn._ctx, _conn._env._errh, _loc, newlen);
        oci_check_error(_conn._env._errh, res);
    }

Here is the call graph for this function:

ub4 OCIPL::OciClob::write ( const dvoid *  bufp,
ub4  buflen,
ub4  offset,
ub4  amount,
ub2  csid = 0,
ub1  csfrm = SQLCS_IMPLICIT 
) [inline]

Definition at line 2224 of file ocipl.h.

References OCIPL::oci_check_error().

    {
        sword res = OCILobWrite(_conn._ctx, _conn._env._errh, _loc,
                      &amount, offset, (dvoid*)bufp, buflen,
                      OCI_ONE_PIECE/*ub1 piece*/, NULL/*dvoid* ctxp*/, NULL/*sb4 (*cbfp)(dvoid*ctxp,dvoid*bufp,ub4*len,ub1*piece)*/,
                      csid, csfrm);

        oci_check_error(_conn._env._errh, res);

        return amount;
    }

Here is the call graph for this function:


Friends And Related Function Documentation

friend struct OciOpenLob [friend, inherited]

Definition at line 2123 of file ocipl.h.


Member Data Documentation

OciConnection& OCIPL::OciLob::_conn [protected, inherited]

Definition at line 2120 of file ocipl.h.

SqlInd OCIPL::SqlValue::_ind [protected, inherited]
OCILobLocator* OCIPL::OciLob::_loc [protected, inherited]

The documentation for this struct was generated from the following file: