Purging Objects
[API's]

Detailed Description

These functions are used to purge obsolete object versions and the meta-data kept for deleted objects.


Functions

alp_status_t alp_hscm_get_deleted_objects_size (AlpHsChangeMgrHandle hChgMgr, uint32_t *pTotalSize)
 Retrieves the total (disk) space occupied by the meta-data for deleted objects in the current datastore.
alp_status_t alp_hscm_purge_all_objects (AlpHsChangeMgrHandle hChgMgr)
alp_status_t alp_hscm_purge_deleted_objects (AlpHsChangeMgrHandle hChgMgr)
 Purge deleted objects from the current datastore.
alp_status_t alp_hscm_purge_obsolete_versions (AlpHsChangeMgrHandle hChgMgr)
 Purge obsolete object version from the current datastore.

Function Documentation

alp_status_t alp_hscm_get_deleted_objects_size (  AlpHsChangeMgrHandle  hChgMgr,
uint32_t *  pTotalSize
) 
 

Retrieves the total (disk) space occupied by the meta-data for deleted objects in the current datastore.

Parameters:
[in] hChgMgr Handle to an open ChangeMgr
[out] pTotalSize Size of meta-data for deleted objects
Remarks:
An application can call this function to determine whether to purge deleted objects.
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.

alp_status_t alp_hscm_purge_all_objects (  AlpHsChangeMgrHandle  hChgMgr  ) 
 

Parameters:
[in] hChgMgr Handle to an open ChangeMgr
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.

alp_status_t alp_hscm_purge_deleted_objects (  AlpHsChangeMgrHandle  hChgMgr  ) 
 

Purge deleted objects from the current datastore.

The ChangeMgr retains identification and other meta-data for deleted objects. Over time, this information may consume a significant amount of space. HotSync allows applications to recover this space by purging deleted objects. When a purge removes information about deleted objects that is required for a subsequent sync, the information is recovered by synchronizing id sets (see alp_hscm_query_object_guids()).

Parameters:
[in] hChgMgr Handle to an open ChangeMgr
Remarks:
Purging is not allowed while there is an open snapshot. See alp_hscm_open_snapshot().
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.

alp_status_t alp_hscm_purge_obsolete_versions (  AlpHsChangeMgrHandle  hChgMgr  ) 
 

Purge obsolete object version from the current datastore.

This function may be called at any time to purge obsolete objects from the DataStore passed to alp_hscm_open(). HotSync calls this function after it closes the snapshot of changes taken for each sync session.

Parameters:
[in] hChgMgr Handle to an open ChangeMgr
Remarks:
Purging is not allowed while there is an open snapshot. See alp_hscm_open_snapshot().
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.

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.