include/alp/hs_change_mgr.h File Reference


Detailed Description

Header file for the HotSync Change Manager Application API.

#include <alp/types.h>
#include <alp/hs_common.h>

Go to the source code of this file.

Data Structures

struct  _AlpHsMonitorPolicy
struct  _AlpHsMonitorStatus

Defines

#define ALP_HS_CHANGE_MGR_H   1

Typedefs

typedef void * AlpHsBatchHandle
typedef _AlpHsMonitorPolicy AlpHsMonitorPolicy
typedef AlpHsMonitorPolicyAlpHsMonitorPolicyPtr
typedef void * AlpHsMonitorPtr
typedef _AlpHsMonitorStatus AlpHsMonitorStatus
typedef AlpHsMonitorStatusAlpHsMonitorStatusPtr
typedef void * AlpHsObjectUpdateHandle

Functions

alp_status_t alp_hscm_acquire_datastore_monitor (AlpHsChangeMgrHandle hChgMgr, AlpHsMonitorPolicyPtr pPolicy, AlpHsMonitorPtr *ppMonitor)
 Acquire a monitor for an entire datastore.
alp_status_t alp_hscm_acquire_object_monitor (AlpHsChangeMgrHandle hChgMgr, AlpLuid objLuid, AlpHsMonitorPolicyPtr pPolicy, AlpHsMonitorPtr *ppMonitor)
 Acquire a monitor for a single object.
alp_status_t alp_hscm_begin_create_with_extended_guid (AlpHsChangeMgrHandle hChgMgr, AlpHsMonitorPtr pMonitor, unsigned int luidCount, AlpLuidPtr pLuids, AlpLuidPtr pNewLuid, AlpHsObjectUpdateHandle *pHandle)
 Create a new object with an extended guid.
alp_status_t alp_hscm_begin_create_with_external_guid (AlpHsChangeMgrHandle hChgMgr, AlpHsMonitorPtr pMonitor, AlpGuidPtr pExternalGuid, AlpLuidPtr pNewLuid, AlpHsObjectUpdateHandle *pHandle)
 Create a new object identified by the input GUID.
alp_status_t alp_hscm_begin_modify (AlpHsChangeMgrHandle hChgMgr, AlpHsObjectState state, AlpHsMonitorPtr pMonitor, AlpLuidPtr pId, AlpLuid localForwardingAddress, AlpHsObjectUpdateHandle *pHandle)
 Begin an object modify.
alp_status_t alp_hscm_begin_modify_batch (AlpHsChangeMgrHandle hChgMgr, AlpHsBatchHandle *phBatch)
 Begin a batch of object modifications.
alp_status_t alp_hscm_close (AlpHsChangeMgrHandle hChgMgr)
 Close the Change Manager.
alp_status_t alp_hscm_end_modify (AlpHsObjectUpdateHandle hChgMgr, bool modifySucceeded, AlpHsMonitorPtr *ppObjectMonitor)
 End an object modify.
alp_status_t alp_hscm_end_modify_batch (AlpHsChangeMgrHandle hChgMgr, bool batchSucceeded)
 End a batch of object modifications.
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_get_monitor_policy (AlpHsMonitorPtr pMonitor, AlpHsMonitorPolicyPtr pPolicy)
 Gets the policy associated with a monitor.
alp_status_t alp_hscm_get_monitor_status (AlpHsChangeMgrHandle hChgMgr, AlpHsMonitorPtr pMonitor, AlpHsMonitorStatusPtr pStatus)
 Returns the status associated with a monitor.
alp_status_t alp_hscm_join_modify_batch (AlpHsChangeMgrHandle hChgMgr, AlpHsBatchHandle hBatch)
 Join an batch of object modifications.
alp_status_t alp_hscm_open (const _TCHAR *nodeName, const _TCHAR *locURI, uint32_t userId, AlpHsDbPtr pDb, AlpHsChangeMgrHandle *phChgMgr)
 Open the Change Manager for a specified 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.
alp_status_t alp_hscm_query_object_luids (AlpHsChangeMgrHandle hChgMgr, bool skipDeletes, bool skipObsoleteVersions, uint32_t *pLuidCount, AlpLuidPtr pLuidArray)
 Used to query for LUIDs in a DataStore.
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_register_data_store (uint32_t userId, AlpHsDataStoreRegistrationPtr pReg)
 Register a datastore with the ChangeMgr.
alp_status_t alp_hscm_release_monitor (AlpHsChangeMgrHandle hChgMgr, AlpHsMonitorPtr pMonitor)
 Release an object or datastore monitor.
alp_status_t alp_hscm_set_monitor_policy (AlpHsMonitorPtr pMonitor, AlpHsMonitorPolicyPtr pPolicy)
 Sets the policy associated with a monitor.
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).
alp_status_t alp_hscm_unregister_data_store (const _TCHAR *nodeName, uint32_t userId, const _TCHAR *locURI)
 Unregister a datastore with the ChangeMgr (NOTE: this function is not implemented).


Define Documentation

#define ALP_HS_CHANGE_MGR_H   1
 


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

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