include/alp/hs_data_store_ext.h File Reference


Detailed Description

Public header file for the HotSync External DataStore API.

Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved. Copyright (c) 2006-2007 ACCESS Systems Americas, Inc. All rights reserved.

#include <alp/hs_common.h>

Go to the source code of this file.

Data Structures

struct  AlpHsExtChangesReportSet
 Contains an array of added/modified/deleted external IDs. More...

Functions

alp_status_t alp_hsds_ext_add (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pSrcType, bool isReferenceable, AlpHsExternalID *pComponentExtIds, size_t componentExtIdSize, size_t offset, bool moreData, size_t bufSize, const _TCHAR *pBuf, AlpHsExternalID *pNewExtId)
 Add an object.
alp_status_t alp_hsds_ext_begin_db_transaction (AlpHsDataStoreHandle hDs)
 Start a transaction on the datastore's content.
alp_status_t alp_hsds_ext_clear_change_info (AlpHsDataStoreHandle hDs)
 Clears the status tracking flags after successfully recording all IDs from alp_hsds_ext_get_change_info.
alp_status_t alp_hsds_ext_close (AlpHsDataStoreHandle hDs)
 Closes an external datastore.
alp_status_t alp_hsds_ext_delete (AlpHsDataStoreHandle hDs, AlpHsExternalID *pExtId)
 Delete an object.
alp_status_t alp_hsds_ext_end_db_transaction (AlpHsDataStoreHandle hDs)
 Commit a transaction that was started in alp_hsds_ext_begin_db_transaction.
alp_status_t alp_hsds_ext_get_change_info (AlpHsDataStoreHandle hDs, AlpHsExtChangesReportSet *report_set, int16_t iCountRead, bool *moreData)
 Gets an array of added/modified/deleted records from an external datastore since the last sync.
alp_status_t alp_hsds_ext_is_version_current (AlpHsDataStoreHandle hDs, AlpHsDataStoreVersionType type, uint32_t version, bool *isCurrent)
 Determine whether the capabilities or string table version is current.
alp_status_t alp_hsds_ext_open (const _TCHAR *locURI, uint32_t userId, AlpHsDataStoreHandle *phDs)
 Opens an external datastore.
alp_status_t alp_hsds_ext_read (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pTgtType, AlpHsExternalID *pExtId, size_t offset, bool *moreData, size_t *pBufSize, _TCHAR *pBuf)
 Read an object's content.
alp_status_t alp_hsds_ext_read_capabilities (AlpHsDataStoreHandle hDs, uint32_t *pCurrentVersion, size_t *pSize, _TCHAR *pBuffer)
 Read the DataStore's capabilities.
alp_status_t alp_hsds_ext_read_string_table (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pObjType, uint32_t *pCurrentVersion, size_t *pSize, _TCHAR *pBuffer)
 Read the DataStore's WBXML string table for the input object type.
alp_status_t alp_hsds_ext_replace (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pSrcType, AlpHsExternalID *pExtId, size_t offset, bool moreData, size_t bufSize, const _TCHAR *pBuf, bool *pExtIdChanged)
 Replace an object's content.
alp_status_t alp_hsds_ext_rollback_db_transaction (AlpHsDataStoreHandle hDs)
 Roll back a transaction that was started in alp_hsds_ext_begin_db_transaction.
alp_status_t alp_hsds_ext_update (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pSrcType, AlpHsExternalID *pExtId, size_t offset, bool moreData, size_t bufSize, const _TCHAR *pBuf, bool *pExtIdChanged)
 Update an object's content.


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.