API's
[Comparators]


Functions

alp_status_t alp_hs_canonical_comparator_convert (AlpHsObjectComparatorHandle comparatorHandle, size_t size, _TCHAR *buffer, size_t *pSize, _TCHAR **pBuffer)
 HotSync calls this function to convert an object from external to canonical form.
alp_status_t alp_hs_canonical_comparator_release (AlpHsObjectComparatorHandle comparatorHandle, size_t size, _TCHAR *buffer)
 HotSync calls this function to release an object in canonical form.
alp_status_t alp_hs_comparator_begin (_TCHAR *id, AlpHsObjectComparatorHandle *pComparatorHandle)
 HotSync calls this function to obtain the handle to a comparator.
alp_status_t alp_hs_comparator_end (AlpHsObjectComparatorHandle comparatorHandle)
 HotSync calls this function to release a compare function handle.
alp_status_t alp_hs_external_comparator_apply (AlpHsObjectComparatorHandle comparatorHandle, size_t size1, _TCHAR *buffer1, size_t size2, _TCHAR *buffer2, int *comparisonResult)
 HotSync calls this function to compare two objects in external form.
alp_status_t alp_hs_internal_comparator_apply (AlpHsObjectComparatorHandle comparatorHandle, AlpHsInternalObjectHandle objectHandle1, AlpHsInternalObjectHandle objectHandle2, int *comparisonResult)
 HotSync calls this function to compare objects in internal form.
alp_status_t alp_hs_internal_comparator_convert (AlpHsObjectComparatorHandle comparatorHandle, size_t size, _TCHAR *buffer, AlpHsInternalObjectHandle *pObjectHandle)
 HotSync calls this function to convert an object from external to internal form.
alp_status_t alp_hs_internal_comparator_release (AlpHsObjectComparatorHandle comparatorHandle, AlpHsInternalObjectHandle objectHandle)
 HotSync calls this function to release an object in internal form.

Function Documentation

alp_status_t alp_hs_canonical_comparator_convert (  AlpHsObjectComparatorHandle  comparatorHandle,
size_t  size,
_TCHAR *  buffer,
size_t *  pSize,
_TCHAR **  pBuffer
) 
 

HotSync calls this function to convert an object from external to canonical form.

Parameters:
[in] comparatorHandle Comparison function handle
[in] size Count of number of bytes of object to be converted
[in] buffer Buffer with externally encoded content of input object
[out] pSize Count of number of bytes of converted object
[out] pBuffer Buffer supplied by comparator to hold canonical encoding
Returns:
Returns (some error) if object was improperly formed
Remarks:
HotSync calls alp_hs_canonical_comparator_release() to release the buffer.

alp_status_t alp_hs_canonical_comparator_release (  AlpHsObjectComparatorHandle  comparatorHandle,
size_t  size,
_TCHAR *  buffer
) 
 

HotSync calls this function to release an object in canonical form.

Parameters:
[in] comparatorHandle Comparison function handle
[out] size Count of number of bytes of converted object
[out] buffer Buffer supplied by comparator to hold canonical encoding
Returns:
Description of possible return values, if any.
Remarks:
HotSync calls this function once for each call to alp_hs_canonical_comparator_convert().

alp_status_t alp_hs_comparator_begin (  _TCHAR *  id,
AlpHsObjectComparatorHandle *  pComparatorHandle
) 
 

HotSync calls this function to obtain the handle to a comparator.

Parameters:
[in] id Matches the id of one of the logical comparators.
[out] pComparatorHandle handle to comparator function
Returns:
(some error) if it is unable to produce a comparitor for the given id.
Remarks:
HotSync will later call SyncModuleCompareObjectsEnd to release handle.

alp_status_t alp_hs_comparator_end (  AlpHsObjectComparatorHandle  comparatorHandle  ) 
 

HotSync calls this function to release a compare function handle.

Parameters:
[in] comparatorHandle comparison function handle
Returns:
Description of possible return values, if any.
Remarks:
HotSync calls this function once for each call to alp_hs_comparator_begin().

alp_status_t alp_hs_external_comparator_apply (  AlpHsObjectComparatorHandle  comparatorHandle,
size_t  size1,
_TCHAR *  buffer1,
size_t  size2,
_TCHAR *  buffer2,
int *  comparisonResult
) 
 

HotSync calls this function to compare two objects in external form.

Parameters:
[in] comparatorHandle comparison function handle
[in] size1 count of number of bytes of first object
[in] buffer1 buffer with externally encoded content of first object
[in] size2 count of number of bytes of second object
[in] buffer2 buffer with externally encoded content of second object
[out] comparisonResult -1 for less than, 0 for equality, +1 for greater than
Returns:
Returns (some error) if either object is in improper form.

alp_status_t alp_hs_internal_comparator_apply (  AlpHsObjectComparatorHandle  comparatorHandle,
AlpHsInternalObjectHandle  objectHandle1,
AlpHsInternalObjectHandle  objectHandle2,
int *  comparisonResult
) 
 

HotSync calls this function to compare objects in internal form.

Parameters:
[in] comparatorHandle comparison function handle
[in] objectHandle1 first object for comparison
[in] objectHandle2 second object for comparison
[out] comparisonResult -1 for less than, 0 for equality, +1 for greater than
Returns:
Description of possible return values, if any.

alp_status_t alp_hs_internal_comparator_convert (  AlpHsObjectComparatorHandle  comparatorHandle,
size_t  size,
_TCHAR *  buffer,
AlpHsInternalObjectHandle *  pObjectHandle
) 
 

HotSync calls this function to convert an object from external to internal form.

Parameters:
[in] comparatorHandle Comparison function handle
[in] size Count of number of bytes of object to be converted
[in] buffer Buffer with externally encoded content of input object
[out] pObjectHandle Handle of resulting internal object
Returns:
Returns (some error) if the object is in improper form.
Remarks:
HotSync calls SyncInternalComparatorRelease to release the handle

alp_status_t alp_hs_internal_comparator_release (  AlpHsObjectComparatorHandle  comparatorHandle,
AlpHsInternalObjectHandle  objectHandle
) 
 

HotSync calls this function to release an object in internal form.

Parameters:
[in] comparatorHandle comparison function handle
[in] objectHandle object to be released
Returns:
Description of possible return values, if any.
Remarks:
HotSync calls this function once for each call to alp_hs_internal_comparator_convert().

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

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