Enumerator
[Protocol Common Services]

Detailed Description

Common Enumerator APIs.


Defines

#define POSTAL_ENUMERATOR_DEFAULT_CACHE_SIZE   6
 Enumerator client cache size default value.
#define POSTAL_ENUMERATOR_DEFAULT_DB_CACHE_SIZE   POSTAL_ENUMERATOR_DEFAULT_CACHE_SIZE
 Enumerator db cache size default value.

Functions

alp_status_t alp_postal_enumerator_get_count (AlpPostalEnumerator *iEnumeratorP, uint32_t *oCountP)
 get the number of elements present in the enumerator.
alp_status_t alp_postal_enumerator_goto_index (AlpPostalEnumerator *iEnumeratorP, int iIndex)
 Set the cursor to the given index.
alp_status_t alp_postal_enumerator_set_cache_size (AlpPostalEnumerator *iEnumeratorP, int iCacheSize, int iDBCacheSize)
 set the number of items available in the enumerator. Can only be set after enumerator_init.

Define Documentation

#define POSTAL_ENUMERATOR_DEFAULT_CACHE_SIZE   6
 

Enumerator client cache size default value.

#define POSTAL_ENUMERATOR_DEFAULT_DB_CACHE_SIZE   POSTAL_ENUMERATOR_DEFAULT_CACHE_SIZE
 

Enumerator db cache size default value.

Function Documentation

alp_status_t alp_postal_enumerator_get_count (  AlpPostalEnumerator *  iEnumeratorP,
uint32_t *  oCountP
) 
 

get the number of elements present in the enumerator.

Parameters:
[in] iEnumeratorP the enumerator to work on..
[out] oCountP the number of elements in the enumerator.
Returns:
Returns an error code.

alp_status_t alp_postal_enumerator_goto_index (  AlpPostalEnumerator *  iEnumeratorP,
int  iIndex
) 
 

Set the cursor to the given index.

Parameters:
[in] iEnumeratorP the enumerator to work on.
[in] iIndex move on the cursor from 0 to iIndex, so next GetNext on this enumerator will return the result at the iIndex position (0 based).
Returns:
Returns an error code.

alp_status_t alp_postal_enumerator_set_cache_size (  AlpPostalEnumerator *  iEnumeratorP,
int  iCacheSize,
int  iDBCacheSize
) 
 

set the number of items available in the enumerator. Can only be set after enumerator_init.

Parameters:
[in] iEnumeratorP the enumerator to work on.
[in] iCacheSize the maximum number of items available in the enumerator. use POSTAL_ENUMERATOR_DEFAULT_CACHE_SIZE to use default value.
[in] iDBCacheSize the cache size used for db on server side. use POSTAL_ENUMERATOR_DEFAULT_DB_CACHE_SIZE to use default value.
Returns:
Returns an error code.

Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.