Contents Index ULConduitStream function (deprecated) ULDropDatabase function pdf/preface.pdf

UltraLite User's Guide
  The Embedded SQL Interface
    Library function reference

ULCountUploadRows function


Prototype 

ul_u_long ULCountUploadRows ( 
SQLCA * sqlca
ul_publication_mask publication-mask,
ul_u_long threshold );

Description 

Returns the number of rows that need to be synchronized, either in a set of publications or in the whole database.

One use of the function is to prompt users to synchronize.

Parameters 

sqlca    A pointer to the SQLCA.

publication-mask    A set of publications to check. A value of 0 corresponds to the entire database. The set is supplied as a mask. For example, the following mask corresponds to publications PUB1 and PUB2.:

UL_PUB_PUB1 | UL_PUB_PUB2

For more information on publication masks, see publication synchronization parameter.

threshold    A value that determines the maximum number of rows to count, and so limits the amount of time taken by the call. A value of 0 corresponds to no limit. A value of 1 determines if any rows need to be synchronized.

Example 

The following call checks the entire database for the number of rows to be synchronized:

count = ULCountUploadRows( sqlca, 0, 0 );

The following call checks publications PUB1 and PUB2 for a maximum of 1000 rows:

count = ULCountUploadRows( sqlca, 
UL_PUB_PUB1 | UL_PUB_PUB2, 1000 );

The following call checks to see if any rows need to be synchronized:

count = ULCountUploadRows( sqlca, UL_SYNC_ALL, 1 );

Contents Index ULConduitStream function (deprecated) ULDropDatabase function pdf/preface.pdf