ACAPI_​ListData_​GetNum

Returns the number of listdata in given set.

    GSErrCode  ACAPI_ListData_GetNum (
        Int32              setIndex,
        API_ListDataID     typeID,
        Int32*             count
    );

 

Parameters

setIndex
[in] Index of the sets of the listing database.
typeID
[in] Type of the listdata.
count
[out] Number of listdata type in the set.

 

Return Values

NoError
The function has completed with success.
APIERR_BADID
Invalid listdata type or setIndex was passed.

For other common API errors see the API Errors document.

 

Remarks

This function is used to get the highest available listdata index of the given listdata type in the set.

 

Example


/* How many keys are in the first database set? */

Int32   count;
err = ACAPI_ListData_GetNum (1, API_KeyID, &count);

 

Requirements

Version: API 2.1 or later
Header: ACAPinc.h

 

See Also

API_ListDataID,
ACAPI_ListData_GetSetNum,
Listing Manager, API Functions