include/alp/memo_dml.h File Reference


Detailed Description

Public header for the ALP Memo Data Model.

>

#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <alp/catmgr_dml.h>
#include <alp/types.h>
#include <alp/sysclass.h>
#include <glib.h>

Go to the source code of this file.

Defines

#define ALP_DATAMODEL_NOTIFICATION_TYPE_MEMOS   "alp/datamodel/memos"
#define ALP_STATUS_MEMO_DML_CHANGEMGR_ERROR   (ALP_CLASS_MEMO_DML | 0x00090000)
#define ALP_STATUS_MEMO_DML_DATABASE_BUSY   (ALP_CLASS_MEMO_DML | 0x00060000)
#define ALP_STATUS_MEMO_DML_DATABASE_ERROR   (ALP_CLASS_MEMO_DML | 0x00050000)
#define ALP_STATUS_MEMO_DML_EXCHANGEMGR_ERROR   (ALP_CLASS_MEMO_DML | 0x000C0000)
#define ALP_STATUS_MEMO_DML_INTERNAL_ERROR   (ALP_CLASS_MEMO_DML | 0x00070000)
#define ALP_STATUS_MEMO_DML_INVALID_LUID   (ALP_CLASS_MEMO_DML | 0x00020000)
#define ALP_STATUS_MEMO_DML_INVALID_PARAMETER   (ALP_CLASS_MEMO_DML | 0x00010000)
#define ALP_STATUS_MEMO_DML_NO_MEMORY   (ALP_CLASS_MEMO_DML | 0x00030000)
#define ALP_STATUS_MEMO_DML_NO_RECORD   (ALP_CLASS_MEMO_DML | 0x00040000)
#define ALP_STATUS_MEMO_DML_PDI_ERROR   (ALP_CLASS_MEMO_DML | 0x000B0000)
#define ALP_STATUS_MEMO_DML_RESTRICTED   (ALP_CLASS_MEMO_DML | 0x00080000)
#define ALP_STATUS_MEMO_DML_UDA_ERROR   (ALP_CLASS_MEMO_DML | 0x000A0000)
#define ALP_STATUS_MEMO_DML_UNKNOWN   (ALP_CLASS_MEMO_DML | 0x000D0000)

Typedefs

typedef _AlpMemoDmlColumnType AlpMemoDmlColumnType
typedef _AlpMemoDmlSelectType AlpMemoDmlSelectType

Enumerations

enum  _AlpMemoDmlColumnType { kMemoLUID = 1, kMemoText, kMemoCreationDate, kMemoModificationDate }
enum  _AlpMemoDmlSelectType {
  kMemoDmlSelectAll = 1, kMemoDmlSelectAllOrderByAlpha, kMemoDmlSelectAllOrderByDate, kMemoDmlSelectAllInCategory,
  kMemoDmlSelectAllInCategoryOrderByAlpha, kMemoDmlSelectAllInCategoryOrderByDate, kMemoDmlSelectMemoInCategory, kMemoDmlSelectMemoInCategoryOrderByAlpha,
  kMemoDmlSelectMemoInCategoryOrderByDate, kMemoDmlSelectAllNoCategory, kMemoDmlSelectAllNoCategoryOrderByAlpha, kMemoDmlSelectAllNoCategoryOrderByDate
}

Functions

alp_status_t alp_memo_dml_add_memberships (AlpDmlH dmlH, AlpLuid memoLuid, const AlpLuid *categoryLuidsP, AlpLuid membershipLuid, uint32_t numCategoryLuids)
alp_status_t alp_memo_dml_close (AlpDmlH dmlH)
alp_status_t alp_memo_dml_delete (AlpDmlH dmlH, AlpLuid memoLuid)
AlpDmlH alp_memo_dml_get_catmgr_handle (AlpDmlH dmlH)
alp_status_t alp_memo_dml_insert (AlpDmlH dmlH, AlpDmlItemH memoH, AlpLuid *memoLuid)
alp_status_t alp_memo_dml_item_create (AlpDmlItemH *memoH)
alp_status_t alp_memo_dml_item_destroy (AlpDmlItemH memoH)
alp_status_t alp_memo_dml_item_set_int32 (AlpDmlItemH memoH, AlpMemoDmlColumnType column, const int32_t *value)
alp_status_t alp_memo_dml_item_set_string (AlpDmlItemH memoH, AlpMemoDmlColumnType column, const char *value)
 Deprecated. Use alp_memo_dml_statement_set_int32 instead.
alp_status_t alp_memo_dml_listview_statement_begin (AlpDmlH dmlH, AlpLuid categoryLuid, bool unfiled, AlpDmlStatementH *stmtH, AlpMemoDmlSelectType selectT, int32_t limit, int32_t offset, uint32_t *numResultsP)
alp_status_t alp_memo_dml_open (AlpDmlH *dmlH, bool changeTrackingOn)
alp_status_t alp_memo_dml_read_from_vNote_buffer (AlpDmlH dmlH, const uint8_t *dataBuf, uint32_t size, bool fromExgMgr, bool forModify, GList **memoLuids)
 Deprecated. Use alp_memo_dml_read_from_vNote_file instead.
alp_status_t alp_memo_dml_read_from_vNote_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, bool forModify, GList **memoLuids)
alp_status_t alp_memo_dml_remove_memberships (AlpDmlH dmlH, AlpLuid memoLuid, const AlpLuid *categoryLuids, AlpLuid membershipLuid, uint32_t numCategoryLuids)
 Deprecated. Use alp_memo_dml_add_memberships instead.
alp_status_t alp_memo_dml_search_begin (AlpDmlH dmlH, AlpDmlStatementH *stmtH, const char *search_string, uint32_t *numResults)
alp_status_t alp_memo_dml_search_statement_begin (AlpDmlH dmlH, AlpDmlStatementH *stmtH, const char *search_string, uint32_t *numResults)
 Deprecated. Use alp_memo_dml_search_begin instead.
alp_status_t alp_memo_dml_statement_begin (AlpDmlH dmlH, AlpLuid memoLuid, AlpLuid categoryLuid, bool unfiled, AlpDmlStatementH *stmtH, AlpMemoDmlSelectType selectT, uint32_t *numResultsP)
alp_status_t alp_memo_dml_statement_copy_string (AlpDmlStatementH stmtH, AlpMemoDmlColumnType column, char **value)
 Deprecated. Use alp_memo_dml_statement_get_int32 instead.
alp_status_t alp_memo_dml_statement_end (AlpDmlStatementH stmtH)
alp_status_t alp_memo_dml_statement_get_int32 (AlpDmlStatementH stmtH, AlpMemoDmlColumnType column, int32_t *value)
alp_status_t alp_memo_dml_statement_get_luid (AlpDmlStatementH stmtH, AlpLuid *memoLuid)
alp_status_t alp_memo_dml_statement_next (AlpDmlStatementH stmtH)
alp_status_t alp_memo_dml_statement_reference_string (AlpDmlStatementH stmtH, AlpMemoDmlColumnType column, char **value)
alp_status_t alp_memo_dml_transaction_begin (AlpDmlH dmlH, bool exclusive)
alp_status_t alp_memo_dml_transaction_end (AlpDmlH dmlH)
alp_status_t alp_memo_dml_transaction_rollback (AlpDmlH dmlH)
alp_status_t alp_memo_dml_update (AlpDmlH dmlH, AlpDmlItemH memoH, AlpLuid memoLuid)
alp_status_t alp_memo_dml_write_to_vNote_buffer (AlpDmlH dmlH, uint8_t **dataBuf, uint32_t *size, bool toExgMgr, const GList *memoLuids)
 Deprecated. Use alp_memo_dml_write_to_vNote_file instead.
alp_status_t alp_memo_dml_write_to_vNote_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, const GList *memoLuids)
 Deprecated. Use alp_memo_dml_read_from_vNote_buffer instead.
alp_status_t alp_prv_memo_dml_statement_get_string (AlpDmlStatementH stmtH, AlpMemoDmlColumnType columnT, bool copy, char **valueP)
 Deprecated. Use alp_memo_dml_statement_copy_string or alp_memo_dml_statement_reference_string instead.


Define Documentation

#define ALP_DATAMODEL_NOTIFICATION_TYPE_MEMOS   "alp/datamodel/memos"
 

Data-change notification-type for "memos". Any data-change in content, category, membership of a memo will fire this notification-event.


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.