NAME

cxDataRefCntGet - return data reference count
#include <cx/DataOps.h>

int cxDataRefCntGet( void *data )
integer function cxDataRefCntGet( data )
integer data
data
IRIS Explorer reference counted data object.
cxDataRefCntGet returns the reference count of a data object. The reference count normally indicates the number of modules that refer to this data. That is usually the number of input ports the data has been sent to, plus one for each output port that sent (or relayed) the data. The count should never be less than this number. The count may be larger if any module user function increments the count to retain the data for extra processing.

Note that, because modules are independent processes, the reference count may be changed at any time by other modules. It is possible that the reference count may no longer be correct by the time it is actually used by the module that called cxDataRefCntGet. On the other hand, if the count is 0 or 1, then the calling module must have the only remaining reference to this data.

cxDataRefInc(3E), cxDataRefDec(3E)
Last modified: Mon Nov 6 16:33:06 GMT 2000
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996