|
Error code definitions for attention data model |
#define | ALP_STATUS_ATTN_DML_BAD_PARAM (ALP_STATUS_ATTN_DML | 0x00000100) |
#define | ALP_STATUS_ATTN_DML_NO_MEMORY (ALP_STATUS_ATTN_DML | 0x00000200) |
#define | ALP_STATUS_ATTN_DML_INTERNAL_ERROR (ALP_STATUS_ATTN_DML | 0x00000300) |
#define | ALP_STATUS_ATTN_DML_NO_RECORDS (ALP_STATUS_ATTN_DML | 0x00000400) |
#define | ALP_STATUS_ATTN_DML_INVALID_LUID (ALP_STATUS_ATTN_DML | 0x00000500) |
#define | ALP_STATUS_ATTN_DML_DATABASE_ERROR (ALP_STATUS_ATTN_DML | 0x00000600) |
#define | ALP_STATUS_ATTN_DML_DUPLICATE (ALP_STATUS_ATTN_DML | 0x00000700) |
#define | ALP_STATUS_ATTN_DML_CORRUPT (ALP_STATUS_ATTN_DML | 0x00000800) |
#define | ALP_STATUS_ATTN_DML_EXISTS (ALP_STATUS_ATTN_DML | 0x00000900) |
Attention DML DataModel API |
alp_status_t | alp_attn_dml_open (AlpDmlH *dmlH) |
alp_status_t | alp_attn_dml_close (AlpDmlH dmlH) |
alp_status_t | alp_attn_dml_set_filename (const char *directory, const char *filename) |
const char * | alp_attn_dml_get_filename (void) |
| Return db pathname.
|
alp_status_t | alp_attn_dml_check_database (AlpDmlH dmlH) |
| Check database integrity.
|
Attention DML Item API |
alp_status_t | alp_attn_dml_item_create (AlpAttnDmlItemType itemType, AlpDmlItemH *itemH) |
alp_status_t | alp_attn_dml_item_destroy (AlpDmlItemH itemH) |
alp_status_t | alp_attn_dml_item_set_int32 (AlpDmlItemH itemH, AlpAttnDmlColumnType column, int32_t *value) |
alp_status_t | alp_attn_dml_item_set_uint32 (AlpDmlItemH itemH, AlpAttnDmlColumnType column, uint32_t *value) |
alp_status_t | alp_attn_dml_item_set_bool (AlpDmlItemH itemH, AlpAttnDmlColumnType column, bool *value) |
alp_status_t | alp_attn_dml_item_set_string (AlpDmlItemH itemH, AlpAttnDmlColumnType column, const char *value) |
alp_status_t | alp_attn_dml_item_set_blob (AlpDmlItemH itemH, AlpAttnDmlColumnType column, void *data, uint32_t size) |
const char * | alp_attn_dml_item_get_string (AlpDmlItemH itemH, AlpAttnDmlColumnType column) |
int32_t | alp_attn_dml_item_get_int32 (AlpDmlItemH itemH, AlpAttnDmlColumnType column) |
uint32_t | alp_attn_dml_item_get_uint32 (AlpDmlItemH itemH, AlpAttnDmlColumnType column) |
alp_status_t | alp_attn_dml_item_set_property_list (AlpDmlItemH itemH, AlpDmlItemH propListH) |
| miscellaneous setter / getter functions These are for adding / getting properties associated with an alert.
|
alp_status_t | alp_attn_dml_item_add_property (AlpDmlItemH itemH, AlpDmlItemH propH) |
Attention DML Write API |
alp_status_t | alp_attn_dml_insert (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid *itemLuid) |
alp_status_t | alp_attn_dml_replace (AlpDmlH dmlH, AlpDmlItemH itemH) |
alp_status_t | alp_attn_dml_update (AlpDmlH dmlH, AlpDmlItemH itemH) |
alp_status_t | alp_attn_dml_delete (AlpDmlH dmlH, AlpDmlItemH itemH) |
alp_status_t | alp_attn_dml_find (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid *itemLuid) |
Attention DML Read API |
alp_status_t | alp_attn_dml_alert_statement_begin (AlpDmlH dmlH, AlpDmlStatementH *stmtH, char *source, char *name, char *handle, AlpLuid alertLuid, AlpAttnDmlOrderByType orderBy, uint32_t *numResults) |
| Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of AlertItem's in the Attention data model.
|
alp_status_t | alp_attn_dml_prop_statement_begin (AlpDmlH dmlH, AlpDmlStatementH *stmtH, AlpLuid alertLuid, AlpLuid propLuid, char *property, uint32_t *numResults) |
| Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of PropertyItem's in the Attention data model.
|
alp_status_t | alp_attn_dml_statement_next (AlpDmlStatementH stmtH) |
| Given a statement handle initialized with alp_attn_dml_*_statement_init() API, this routine will step the statement forward to point to the next item in the sequence.
|
alp_status_t | alp_attn_dml_statement_end (AlpDmlStatementH stmtH) |
| Close/end the selection statement.
|
alp_status_t | alp_attn_dml_statement_get_int32 (AlpDmlStatementH stmtH, AlpAttnDmlColumnType column, int32_t *value) |
| Get a int32_t from the current statement record statementH must be from a previous call to begin.
|
alp_status_t | alp_attn_dml_statement_get_uint32 (AlpDmlStatementH stmtH, AlpAttnDmlColumnType column, uint32_t *value) |
| Get a uint32_t from the current statement record statementH must be from a previous call to begin.
|
alp_status_t | alp_attn_dml_statement_get_int64 (AlpDmlStatementH stmtH, AlpAttnDmlColumnType column, int64_t *value) |
| Get a int64_t from the current statement record statementH must be from a previous call to begin.
|
alp_status_t | alp_attn_dml_statement_get_string (AlpDmlStatementH stmtH, AlpAttnDmlColumnType column, char **value) |
| @ brief Get a text string from the current statement record statementH must be from a previous call to begin
|
alp_status_t | alp_attn_dml_statement_get_bool (AlpDmlStatementH stmtH, AlpAttnDmlColumnType column, bool *value) |
| Get a bool from the current statement record statementH must be from a previous call to begin.
|
alp_status_t | alp_attn_dml_statement_get_timestamp (AlpDmlStatementH stmtH, AlpAttnDmlColumnType column, time_t *value) |
| Get the timestamp from the current statement record statementH must be from a previous call to begin.
|
alp_status_t | alp_attn_dml_statement_get_luid (AlpDmlStatementH stmtH, AlpLuid *itemLuid) |
| Get the luid from the current statement record.
|
alp_status_t | alp_attn_dml_statement_get_blob (AlpDmlStatementH stmtH, AlpAttnDmlColumnType column, bool copy, void **value, uint32_t *size) |
| Given a statement handle that has been initialized and stepped using alp_attn_dml_statement_next() where an item has been found, this function can be used to retrieve any integer field from the item located at the current statement position.
|
Attention DML Transaction API |
alp_status_t | alp_attn_dml_transaction_begin (AlpDmlH dmlH, bool exclusive) |
alp_status_t | alp_attn_dml_transaction_end (AlpDmlH dmlH) |
alp_status_t | alp_attn_dml_transaction_rollback (AlpDmlH dmlH) |
Enumerations |
enum | AlpAttnDmlItemType { InvalidItem = 0,
AlertItem = 1,
PropertyItem = 2,
PropertyListItem = 3
} |
enum | AlpAttnDmlColumnType {
Source = 1,
Name = 2,
Handle = 3,
Interface = 4,
Priority = 5,
Duration = 6,
Pending = 7,
Attributes = 8,
AlertLuid = 9,
Value = 10,
Property = 11,
PropLuid = 12,
UserId = 13,
GroupId = 14,
Created = 15,
Updated = 16,
PropType = 17
} |
| The enum below lists all the fields that can be get and set in any of the AlpContactsDmlItemType's above. More...
|
enum | AlpAttnDmlOrderByType { OrderByNone,
OrderByPriority,
OrderByTimestamp,
NumOrderByAttnTypes
} |
| Used by alp_attn_dml_alerts_statement_begin(). More...
|