include/alp/hs_data_store.h File Reference


Detailed Description

Public header file for the HotSync 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.

Functions

alp_status_t alp_hsds_add (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pSrcType, bool isReferenceable, AlpLuid newId, AlpLuid *pComponentIds, size_t componentIdSize, size_t offset, bool moreData, size_t bufSize, const _TCHAR *pBuf)
 Add an object.
alp_status_t alp_hsds_close (AlpHsDataStoreHandle hDs)
 Close a DataStore.
alp_status_t alp_hsds_copy (AlpHsDataStoreHandle hDs, AlpLuid srcId, AlpLuid tgtId)
 Copy an object.
alp_status_t alp_hsds_delete (AlpHsDataStoreHandle hDs, AlpLuid id)
 Delete an object.
alp_status_t alp_hsds_get_db_handle (AlpHsDataStoreHandle hDs, AlpHsDbPtr pDb, AlpHsDbHandle *phDb)
 Get a pointer to a datastore's database handle.
alp_status_t alp_hsds_is_refresh_required (AlpHsDataStoreHandle hDs, bool *pIsRequired)
alp_status_t alp_hsds_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_open (const _TCHAR *locURI, uint32_t userId, AlpHsDbPtr *ppDb, AlpHsDataStoreHandle *phDs)
 Open a DataStore.
alp_status_t alp_hsds_purge (AlpHsDataStoreHandle hDs)
alp_status_t alp_hsds_read (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pTgtType, AlpLuid id, size_t offset, bool *moreData, size_t *pBufSize, _TCHAR *pBuf)
 Read an object's content.
alp_status_t alp_hsds_read_capabilities (AlpHsDataStoreHandle hDs, uint32_t *pCurrentVersion, size_t *pSize, _TCHAR *pBuffer)
 Read the DataStore's capabilities.
alp_status_t alp_hsds_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_rekey (AlpHsDataStoreHandle hDs, AlpLuid oldId, AlpLuid newId)
 Assign a new id to an existing object.
alp_status_t alp_hsds_replace (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pSrcType, AlpLuid id, size_t offset, bool moreData, size_t bufSize, const _TCHAR *pBuf)
 Replace an object's content.
alp_status_t alp_hsds_update (AlpHsDataStoreHandle hDs, AlpHsObjectTypePtr pSrcType, AlpLuid id, size_t offset, bool moreData, size_t bufSize, const _TCHAR *pBuf)
 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.