Open
[API's]


Functions

alp_status_t alp_hscm_close_datastore (AlpHsChangeMgrHandle hChgMgr)
 Closes a datastore without closing the ChangeMgr.
alp_status_t alp_hscm_open_datastore (AlpHsChangeMgrHandle hChgMgr, const _TCHAR *locURI)
 Opens a datastore.
alp_status_t alp_hscm_open_for_sync (const _TCHAR *nodeName, const _TCHAR *syncMgrLocURI, uint32_t userId, void *pContext, AlpHsObjectComparatorFnPtr cmpObjs, AlpHsChangeMgrHandle *phChgMgr)
 Opens the ChangeMgr for synchronization operations.
alp_status_t alp_hscm_prepare_for_sync (AlpHsChangeMgrHandle hChgMgr)
 Prepares a datastore for synchronization operations.

Function Documentation

alp_status_t alp_hscm_close_datastore (  AlpHsChangeMgrHandle  hChgMgr  ) 
 

Closes a datastore without closing the ChangeMgr.

Parameters:
[in] hChgMgr The ChangeMgr handle
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
Remarks:
It is not necessary to call this function before calling alp_hscm_open_datastore().
See also:
alp_hscm_open_for_sync(), alp_hscm_open_datastore().

alp_status_t alp_hscm_open_datastore (  AlpHsChangeMgrHandle  hChgMgr,
const _TCHAR *  locURI
) 
 

Opens a datastore.

Parameters:
[in] hChgMgr The ChangeMgr handle
[in] locURI The datastore's locURI.
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
Remarks:
If the input ChangeMgr is already open for another datastore, that datastore is closed before the input datastore is opened.
See also:
alp_hscm_open_for_sync().

alp_status_t alp_hscm_open_for_sync (  const _TCHAR *  nodeName,
const _TCHAR *  syncMgrLocURI,
uint32_t  userId,
void *  pContext,
AlpHsObjectComparatorFnPtr  cmpObjs,
AlpHsChangeMgrHandle *  phChgMgr
) 
 

Opens the ChangeMgr for synchronization operations.

Unlike alp_hscm_open(), this function opens the ChangeMgr without also opening a datastore. alp_hscm_open_datastore() can then be called to open a specific datastore. Together these two functions allow the caller to open a series of datastores without closing and re-opening the ChangeMgr. This is primarily a convenience for synchronization applications that need to iterate over a series of datastores during a synchronization session.

Call alp_hscm_close() to close a ChangeMgr instance that was opened using this function.

Parameters:
[in] nodeName Desktop only. On ALP, this parameter must be set to ALP_HS_DEFAULT_NODE_NAME.
[in] syncMgrLocURI The caller's locURI
[in] userId Desktop only.
[in] pContext Desktop only.
[in] cmpObjs Desktop only.
[out] phChgMgr Pointer to a ChangeMgr handle
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
See also:
alp_hscm_open(), alp_hscm_open_datastore(), alp_hscm_close().

alp_status_t alp_hscm_prepare_for_sync (  AlpHsChangeMgrHandle  hChgMgr  ) 
 

Prepares a datastore for synchronization operations.

This function gives an opened datastore a chance to perform extra steps before synchronization starts.

For external datastores (kChMgrTypeExternal), the ChangeMgr queries the datastore for newly added, modified, or deleted objects, then records these changes. The external datastore APIs called are alp_hsds_ext_get_change_info and alp_hsds_ext_clear_change_info.

For datastore using the ChangeMgr (kChMgrTypeHotsync), no extra steps are performed, thus, no datastore APIs are called.

Parameters:
[in] hChgMgr The ChangeMgr handle
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
Remarks:
This call requires an opened datastore.

This call must be made when syncing with external datastores (kChMgrTypeExternal).

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.