INFORMIX
DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions
Home Contents Index Master Index New Book

mi_lo_stat_refcnt()

The mi_lo_stat_refcnt() function returns from an LO-status structure the reference count of a smart large object.

Syntax

Usage

The mi_lo_stat_refcnt() function is the LO-status accessor function that returns the reference count from a set of status information. The reference count for a smart large object indicates the number of persistently stored LO handles 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 (0) and any of the following conditions exist:

Important: Before you call mi_lo_stat_refcnt(), you must initialize an LO-status structure with the mi_lo_stat() function.

The mi_lo_stat_refcnt() function obtains the reference count from the LO-status structure that LO_stat references.

Return Values

>=0

The reference count for the smart large object whose status information is in the LO-status structure that LO_stat references.

MI_ERROR

The function was not successful.

Related Topics

See the descriptions of the following functions: mi_lo_decrefcount(), mi_lo_increfcount(), mi_lo_stat(), mi_lo_stat_atime(), mi_lo_stat_cspec(), mi_lo_stat_ctime(), mi_lo_stat_free(), mi_lo_stat_mtime_sec(), and mi_lo_stat_size().

In Chapter 3, "Handling Smart Large Objects," see "Status Information" and "Managing the Reference Count" for more information about the reference count of a smart large object. See "The LO-Status Structure", and "Obtaining the Status of a Smart Large Object" for information on how to use the mi_lo_stat_refcnt() function.




DataBlade API Programmer's Manual, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.