Utilities
[API's]


Functions

alp_status_t alp_hscm_get_change_coverage (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr *ppCoverage)
 Retrieve an open datastore's change coverage.
alp_status_t alp_hscm_get_purge_coverage (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr *ppCoverage)
 Retrieves an open datastore's purge coverage.
alp_status_t alp_hscm_purge_all (AlpHsChangeMgrHandle hChgMgr, AlpHsSnapshotHandle hSnapshot)
alp_status_t alp_hscm_query_object_guids (AlpHsChangeMgrHandle hChgMgr, AlpHsSnapshotHandle hSnapshot, uint32_t *pGuidCount, AlpGuidPtr *pGuidArray)
 Retrieve the GUIDs for objects in an open datastore that are present in the input snapshot.
alp_status_t alp_hscm_set_change_coverage (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pCoverage)
 Sets an open datastore's change coverage.

Function Documentation

alp_status_t alp_hscm_get_change_coverage (  AlpHsChangeMgrHandle  hChgMgr,
AlpHsPedigreePtr *  ppCoverage
) 
 

Retrieve an open datastore's change coverage.

Parameters:
[in] hChgMgr Handle to a ChangeMgr open for a datastore
[out] ppCoverage Pointer to a pedigree pointer.
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
See also:
alp_hscm_set_change_coverage().

alp_status_t alp_hscm_get_purge_coverage (  AlpHsChangeMgrHandle  hChgMgr,
AlpHsPedigreePtr *  ppCoverage
) 
 

Retrieves an open datastore's purge coverage.

A datastore's purge coverage records the last "time" when deleted objects were purged from the datastore. Each time alp_hscm_purge_deleted_objects() is called, the open datastore's purge coverage is set to its current change coverage.

Parameters:
[in] hChgMgr Handle to a ChangeMgr open for a datastore
[out] ppCoverage Pointer to a pedigree pointer
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
See also:
alp_hscm_purge_deleted_objects().

alp_status_t alp_hscm_purge_all (  AlpHsChangeMgrHandle  hChgMgr,
AlpHsSnapshotHandle  hSnapshot
) 
 

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_query_object_guids (  AlpHsChangeMgrHandle  hChgMgr,
AlpHsSnapshotHandle  hSnapshot,
uint32_t *  pGuidCount,
AlpGuidPtr *  pGuidArray
) 
 

Retrieve the GUIDs for objects in an open datastore that are present in the input snapshot.

HotSync calls this function when a purge necessitates an id sync.

Parameters:
[in] hChgMgr Handle to a ChangeMgr open for a datastore
[in] hSnapshot Handle to an open snapshot
[in,out] pGuidCount On input, the size of pGuidArray; on output, the number of GUIDs written to pGuidArray.
[in,out] pGuidArray An array of GUIDs
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
Remarks:
The caller is responsible for allocating pGuidArray. The correct size can be found by calling this function with pGuidArray equal to zero.
See also:
alp_hscm_purge_deleted_objects().

alp_status_t alp_hscm_set_change_coverage (  AlpHsChangeMgrHandle  hChgMgr,
AlpHsPedigreePtr  pCoverage
) 
 

Sets an open datastore's change coverage.

This function sets an open datastore's change coverage to the sum of its current coverage with the input coverage. It is normally called after all modified objects have been written to the datastore.

Parameters:
[in] hChgMgr Handle to a ChangeMgr open for a datastore
[in] pCoverage A pedigree pointer
Returns:
If successful returns ALP_STATUS_HOTSYNC_OK; otherwise returns an error.
See also:
alp_hs_pedigree_add_pedigree(), alp_hscm_get_change_coverage(), alp_hscm_write_modified_objects_end().

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.