Content Comparators
[API's]

Detailed Description

These functions are used to register and unregister content comparators with the ChangeMgr. When a remotely edited object is written to a local datastore (see alp_hscm_write_modified_objects_begin()), the ChangeMgr may detect a conflicting local edit of the same object. This typically results in an edit-edit conflict. However, when a comparator for the object's MIME type is registered and indicates that the content of the two edits is identical, the ChangeMgr will avoid generating a conflict and instead set the object's pedigree to the sum of the pedigrees for the two object versions.

When there are multiple comparators for the same MIME type, the user may set a preferred comparator for that type. By default, the preferred comparator for a particular MIME type is the last comparator registered for that type.

See also: hs_comparator.h, hs_common.h.

NOTE: This functionality is not currently implemented. *****


Functions

alp_status_t alp_hscm_register_comparator (uint32_t userId, AlpHsObjectComparatorInfoPtr pCmp)
 Register a comparator with the ChangeMgr (NOTE: this function is not implemented).
alp_status_t alp_hscm_set_preferred_comparator (uint32_t userId, const _TCHAR *cmpId)
 Set the ChangeMgr's preferred comparator for a particular MIME type (NOTE: this function is not implemented).
alp_status_t alp_hscm_unregister_comparator (uint32_t userId, const _TCHAR *cmpId)
 Unregister a comparator with the ChangeMgr (NOTE: this function is not implemented).

Function Documentation

alp_status_t alp_hscm_register_comparator (  uint32_t  userId,
AlpHsObjectComparatorInfoPtr  pCmp
) 
 

Register a comparator with the ChangeMgr (NOTE: this function is not implemented).

Parameters:
[in] userId Desktop only. Should be set to zero for ALP
[in] pCmp The comparator's registration.
Returns:
Returns ALP_STATUS_HOTSYNC_NOT_IMPL.

alp_status_t alp_hscm_set_preferred_comparator (  uint32_t  userId,
const _TCHAR *  cmpId
) 
 

Set the ChangeMgr's preferred comparator for a particular MIME type (NOTE: this function is not implemented).

This function is used to indicate a preferred comparator when multiple comparators are available for the same MIME type.

Parameters:
[in] userId Desktop only. Should be set to zero for ALP
[in] cmpId The comparator's unique id.
Returns:
Returns ALP_STATUS_HOTSYNC_NOT_IMPL.

alp_status_t alp_hscm_unregister_comparator (  uint32_t  userId,
const _TCHAR *  cmpId
) 
 

Unregister a comparator with the ChangeMgr (NOTE: this function is not implemented).

Parameters:
[in] userId Desktop only. Should be set to zero for ALP
[in] cmpId The comparator's unique id.
Returns:
Returns ALP_STATUS_HOTSYNC_NOT_IMPL.

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.