OCIAnyDataAttrGet()

Purpose

Gets the value of the attribute at the current position in the OCIAnyData. Attribute values can be accessed sequentially.

Syntax

sword OCIAnyDataAttrGet ( OCISvcCtx    *svchp, 
                          OCIError     *errhp, 
                          OCIAnyData   *sdata, 
                          OCITypeCode  tc, 
                          OCIType      *attr_type, 
                          dvoid        *null_ind, 
                          dvoid        *attr_value, 
                          ub4          *length, 
                          boolean      is_any );

Parameters

svchp (IN)

The OCI service context.

errhp (IN/OUT)

The OCI error handle. If there is an error, it is recorded in err and this function returns OCI_ERROR. Obtain diagnostic information by calling OCIErrorGet().

sdata (IN/OUT)

Pointer to initialized of type OCIAnyData.

tc (IN)

Typecode of the attribute. Type checking happens based on tc, attr_type and the type information in the OCIAnyData.

attr_type (IN) [OPTIONAL]

attr_type should give the type description of the referenced type (for OCI_TYPECODE_REF) or the type description of the collection type (for OCI_TYPECODE_VARRAY, OCI_TYPECODE_TABLE) or the type description of the object (for OCI_TYPECODE_OBJECT). This parameter is not required for built-in typecodes.

null_ind (OUT)

Indicates if the attr_value is NULL. Pass (OCIInd *) in null_ind for all typecodes except OCI_TYPECODE_OBJECT.

If the typecode is OCI_TYPECODE_OBJECT, pass a pointer (dvoid **) in null_ind.

The indicator returned will be OCI_IND_NOTNULL if the value is not NULL and it will be OCI_IND_NULL for a NULL value.

attr_value (IN/OUT)

Value for the attribute

length (IN/OUT)

Currently, this parameter is ignored. Pass 0 here. In the future, this may be used for certain typecodes where the data representation itself will not give the length, in bytes, implicitly.

is_any (IN)

Is attribute to be returned in the form of OCIAnyData?

Comments

This call can be used with OCIAnyData of typecode OCI_TYPECODE_OBJECT only

• This call gets the value of the attribute at the current position in the OCIAnyData.
• tc must match the type of the attribute at the current position, otherwise an error is returned.
• is_any is applicable only when the typecode of the attribute is one of the following:
  • OCI_TYPECODE_OBJECT,
  • OCI_TYPECODE_VARRAY,
  • OCI_TYPECODE_TABLE.

  If is_any is TRUE, then attr_value is returned in the form of OCIAnyData*.

• You must allocate the memory for the attribute before calling the function. You can allocate memory through OCIObjectNew(). In case of built-in types such as NUMBER, VARCHAR, etc, the attribute can be just a pointer to a stack variable. Here is the list of available Oracle datatypes which can be used as object attribute types and the corresponding types of the attribute value that should be passed:

  Datatypes	attr_value
  VARCHAR2, VARCHAR, CHAR	OCIString **
  NUMBER, REAL, INT, FLOAT, DECIMAL	OCINumber **
  DATE	OCIDate **
  TIMESTAMP	OCIDateTime **
  TIMESTAMP WITH TIME ZONE	OCIDateTime **
  TIMESTAMP WITH LOCAL TIME ZONE	OCIDateTime **
  INTERVAL YEAR TO MONTH	OCIInterval **
  INTERVAL DAY TO SECOND	OCIInterval **
  BLOB	OCILobLocator ** or OCIBlobLocator **
  CLOB	OCILobLocator ** or OCIClobLocator *
  BFILE	OCILobLocator **
  REF	OCIRef **
  RAW	OCIRaw **
  VARRAY	OCIArray ** (or OCIAnyData * if is_any is TRUE)
  TABLE	OCITable ** (or OCIAnyData * if is_any is TRUE)
  OBJECT	dvoid ** (or OCIAnyData * if is_any is TRUE)