The ifx_lo_stat_refcnt() function

The ifx_lo_stat_refcnt() function returns the number of references to a smart large object.

Syntax

mint ifx_lo_stat_refcnt(LO_stat)
   ifx_lo_stat_t *LO_stat;
LO_stat
A pointer to an LO-status structure that ifx_lo_stat() allocates and completes with status information.

Usage

The refcnt argument is the reference count for a smart large object. This count indicates the number of persistently stored LO-pointer (ifx_lo_t) structures that currently exist for the smart large object. The database server assumes that it can safely remove the smart large object and reuse any resources that are allocated to it when the reference count is zero and any of the following conditions exist:
  • The transaction in which the reference count is decremented commits.
  • The connection terminates and the smart large object is created during this connection but its reference count is not incremented.

    The database server increments a reference counter when it stores the LO-pointer structure for a smart large object in a row.

The status information for the smart large object is in the LO-status structure to which LO_stat points. The ifx_lo_stat() function allocates this structure and fills it with the status information for a particular smart large object. Therefore, you must precede a call to ifx_lo_stat_refcnt() with a call to ifx_lo_stat().

Return codes

>=0
The reference count for the smart large object that LO_stat identifies.
-1
The function was not successful.