OCI_oflng

function

Library: Oracle Call Interface database support (OMOCI legacy)
Include: omoci.xin

Returns: Returns OCI_SUCCESS if the function completes without error.

Declaration

define external integer function OCI_oflng
   (  value OCI_Handle_type cursor,
      value integer pos,
      modifiable stream buf,
      value integer bufl,
      value integer dtype,
      modifiable integer retl,
      value integer offset
   )

Purpose

This function fetches a portion of a "long" or "long raw" column.

Input arguments:

cursor -- Cursor data area descriptor.
pos -- The index position of the data column in the row. The first column is position one.
bufl -- The length of the data buffer.
dtype -- The datatype code corresponding to the type of buf. The following values are allowed:
- SQLT_CHR -- (ORANET TYPE) character string
- SQLT_NUM -- (ORANET TYPE) oracle numeric
- SQLT_INT -- (ORANET TYPE) integer
- SQLT_FLT -- (ORANET TYPE) floating point number
- SQLT_STR -- zero terminated string
- SQLT_VNU -- NUM with preceding length byte
- SQLT_PDN -- (ORANET TYPE) packed decimal numeric
- SQLT_LNG -- long
- SQLT_VCS -- variable character string
- SQLT_NON -- null/empty PCC Descriptor entry
- SQLT_RID -- rowid
- SQLT_DAT -- date in oracle format
- SQLT_VBI -- binary in VCS format
- SQLT_BIN -- binary data (DTYBIN)
- SQLT_LBI -- long binary
- SQLT_UIN -- unsigned integer
- SQLT_SLS -- display sign leading separate
- SQLT_LVC - longer longs (char)
- SQLT_LVB -- longer long binary
- SQLT_AFC -- ANSI fixed character
- SQLT_AVC -- ANSI variable character
- SQLT_CUR -- cursor type
- SQLT_LAB -- label type
- SQLT_OSL -- oslabel type
offset -- The zero-based offset of the first byte in the column to be fetched.

Output arguments:

buf -- The returned long-type column data.
retl -- The number of bytes returned. If more than 65535 bytes were requested and returned, the maximum value in this parameter is still 65535.

Example:

  set RetCode to OCI_oflng
        (  Cursor,
           1,
           RawData,
           BufSize,
           SQLT_LBI,
           ChunkSize,
           Offset
        )