Data Types
[Common]

Define Documentation

#define ALP_HS_APPID_DATACHANGE_NOTIFICATION "/alp/datamodel"

AppId for data change notification to identify notifications.

Typedef Documentation

typedef struct _AlpDatamodelChangeData AlpDatamodelChangeData

definition of data object for sending data-change notifications

typedef AlpDatamodelChangeData* AlpDatamodelChangeDataPtr

typedef void* AlpHsChangeMgrHandle

typedef enum _AlpHsChangeMgrType AlpHsChangeMgrType

An enumeration of what change management system a datastore uses for its records.

typedef void* AlpHsDataStoreHandle

typedef struct _AlpHsDataStoreRegistration AlpHsDataStoreRegistration

typedef AlpHsDataStoreRegistration* AlpHsDataStoreRegistrationPtr

typedef enum _AlpHsDataStoreVersionType AlpHsDataStoreVersionType

typedef void* AlpHsDbHandle

typedef void* AlpHsDbPtr

typedef struct _AlpHsExternalID AlpHsExternalID

Represents an ID external to ALP.
This struct is used to represent an ID external to ALP. Because the external ID can be anything, such as an int, string, binary object, etc, it is defined as a void*.
Remarks:
The void* buffer is must be allocated and freed by the calling application. When reading an external ID, the buffer must be large enough to hold the external ID.

typedef struct _AlpHsExternalObject AlpHsExternalObject

This struct is used to be used by alp_hsds_ext_get_change_info. Some objects may exist to define a relationship between other objects. These other objects are considered components of this object. An example of this is category memberships, which defines a relationship between a category and a content. The category object and content object are considered components of this membership object. When reporting these special objects in this structs, the component objects are filled in 'componentExtIds'. The number of component objects are specified by 'componentExtIdSize'.
Because of the way components Ids are designed, there must be at least 2 component Ids. Using 1 component Id is considered invalid and will cause an error. If component Ids are not used, then set 'componentExtIdSize' to 0.

typedef AlpHsExternalObject* AlpHsExternalObjectPtr

typedef alp_status_t(* AlpHsObjectComparatorFnPtr)(void *pContext, const _TCHAR *mimeType, const _TCHAR *mimeVersion, const _TCHAR *targetURI, uint16_t size1, const _TCHAR *buffer1, uint16_t size2, const _TCHAR *buffer2, int *result)

typedef struct _AlpHsObjectComparatorInfo AlpHsObjectComparatorInfo

typedef AlpHsObjectComparatorInfo* AlpHsObjectComparatorInfoPtr

typedef enum _AlpHsObjectComparatorType AlpHsObjectComparatorType

An enumeration of different types of comparators.

typedef enum _AlpHsObjectState AlpHsObjectState

typedef struct _AlpHsObjectType AlpHsObjectType

typedef AlpHsObjectType* AlpHsObjectTypePtr

typedef enum _AlpHsSupportedDbType AlpHsSupportedDbType

Enumeration Type Documentation

enum _AlpHsChangeMgrType

An enumeration of what change management system a datastore uses for its records.

Enumerator:

kChMgrTypeInvalid

kChMgrTypeHotsync The datastore uses the Hotsync's Change Mgr to generate AlpLuids and manage changes for its records.

kChMgrTypeExternal The datastore uses its own external IDs and has its own change managing system.

kChMgrTypeEnumLimit

enum _AlpHsDataStoreVersionType

Enumerator:

kVersionTypeCapabilities

kVersionTypeStringTable

kVersionTypeEnumLimit

enum _AlpHsObjectComparatorType

An enumeration of different types of comparators.

Enumerator:

kComparatorTypeInvalid invalid comparator type.

kComparatorTypeExternal The comparator compares two objects in external, non-canonical form.

kComparatorTypeCanonical The comparator canonizes an object for external binary comparison.

kComparatorTypeInternal The comparator compares two objects in internal opaque form.

kComparatorTypeEnumLimit

enum _AlpHsObjectState

Enumerator:

kObjectStateModified

kObjectStateDeleted

kObjectStateArchived

kObjectStateNew

kObjectStateEnumLimit

enum _AlpHsSupportedDbType

Enumerator:

kDbTypeUnsupported

kDbTypeSQLite

kDbTypeEnumLimit

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


Data Structures
struct	_AlpDatamodelChangeData
struct	_AlpHsDataStoreRegistration
struct	_AlpHsExternalID
	Represents an ID external to ALP. More...
struct	_AlpHsExternalObject
struct	_AlpHsObjectComparatorInfo
	Structure used to describe a single logical comparator. More...
struct	_AlpHsObjectType
Defines
#define	ALP_HS_APPID_DATACHANGE_NOTIFICATION "/alp/datamodel"
	AppId for data change notification to identify notifications.
Typedefs
typedef _AlpDatamodelChangeData	AlpDatamodelChangeData
	definition of data object for sending data-change notifications
typedef AlpDatamodelChangeData *	AlpDatamodelChangeDataPtr
typedef void *	AlpHsChangeMgrHandle
typedef enum _AlpHsChangeMgrType	AlpHsChangeMgrType
	An enumeration of what change management system a datastore uses for its records.
typedef void *	AlpHsDataStoreHandle
typedef _AlpHsDataStoreRegistration	AlpHsDataStoreRegistration
typedef AlpHsDataStoreRegistration *	AlpHsDataStoreRegistrationPtr
typedef enum _AlpHsDataStoreVersionType	AlpHsDataStoreVersionType
typedef void *	AlpHsDbHandle
typedef void *	AlpHsDbPtr
typedef _AlpHsExternalID	AlpHsExternalID
	Represents an ID external to ALP.
typedef _AlpHsExternalObject	AlpHsExternalObject
typedef AlpHsExternalObject *	AlpHsExternalObjectPtr
typedef alp_status_t(*	AlpHsObjectComparatorFnPtr )(void pContext, const _TCHAR mimeType, const _TCHAR mimeVersion, const _TCHAR targetURI, uint16_t size1, const _TCHAR buffer1, uint16_t size2, const _TCHAR buffer2, int *result)
typedef _AlpHsObjectComparatorInfo	AlpHsObjectComparatorInfo
typedef AlpHsObjectComparatorInfo *	AlpHsObjectComparatorInfoPtr
typedef enum _AlpHsObjectComparatorType	AlpHsObjectComparatorType
	An enumeration of different types of comparators.
typedef enum _AlpHsObjectState	AlpHsObjectState
typedef _AlpHsObjectType	AlpHsObjectType
typedef AlpHsObjectType *	AlpHsObjectTypePtr
typedef enum _AlpHsSupportedDbType	AlpHsSupportedDbType
Enumerations
enum	_AlpHsChangeMgrType { kChMgrTypeInvalid = 0, kChMgrTypeHotsync = 1, kChMgrTypeExternal = 2, kChMgrTypeEnumLimit = 3 }
	An enumeration of what change management system a datastore uses for its records. More...
enum	_AlpHsDataStoreVersionType { kVersionTypeCapabilities = 1, kVersionTypeStringTable = 2, kVersionTypeEnumLimit = 3 }
enum	_AlpHsObjectComparatorType { kComparatorTypeInvalid = 0, kComparatorTypeExternal = 1, kComparatorTypeCanonical = 2, kComparatorTypeInternal = 3, kComparatorTypeEnumLimit = 4 }
	An enumeration of different types of comparators. More...
enum	_AlpHsObjectState { kObjectStateModified = 1, kObjectStateDeleted = 2, kObjectStateArchived = 3, kObjectStateNew = 4, kObjectStateEnumLimit = 5 }
enum	_AlpHsSupportedDbType { kDbTypeUnsupported = 0, kDbTypeSQLite = 1, kDbTypeEnumLimit = 2 }

Data Types [Common]

Data Structures

Defines

Typedefs

Enumerations

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Data Types
[Common]