Memo Database Read API
[Data Model API's]

Functions
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_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_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.

---

Function Documentation

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 )

Initializes query statement for the MEMO table to retrieve a resultset by building an AlpDmlStatementH statement handle that selects whatever is specifed by the AlpMemoDmlSelectType from the data model. If the AlpDmlH and AlpDmlStatementH parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. If there are no records in the query, then an ALP_STATUS_MEMO_DML_NO_RECORD is returned. Parameters: [in]  dml  AlpDmlH handle to the Memo data model [in]  categoryLuid  AlpLuid optional parameter, to determine category of items to be returned. If negative, then the statement will include only "Unfiled" items. If 0, then the statement will include "All" items. Otherwise it will only include items of the category membership requested. [in]  unfiled  bool If true, the categoryLuid is ignored and only records that have no category memberships are retrieved. [out]  stmtH  AlpDmlStatementH handle to query statement that is returned to the caller, and to be used to retrieve the data via calls to alp_memo_dml_statement_next() [in]  selectT  AlpMemoDmlSelectType column/field type for query statement [in]  limit  Places an upper bound on the number of rows returned in the result. Zero means no limit. [in]  offset  If limit is non-zero then specifies how many rows to skip at the beginning of the result set. [out]  numResultsP  number of records matching the query statement Returns: alp_status_t See also: alp_memo_dml_statement_next alp_memo_dml_statement_end

alp_status_t alp_memo_dml_search_begin (  AlpDmlH  dmlH, AlpDmlStatementH *  stmtH, const char *  search_string, uint32_t *  numResults )

This API call can be used to search events in memo database Parameters: [in]  dml  data model handle [out]  stmtH,:  AlpSALStatement handlecountClauSmartJoinInfose [in]  search_string,:  string to match. This searches two fields - description, location and it is caseless. [out]  numResults,:  The number of records matching the search criteria. Returns: alp_status_t See also: alp_memo_dml_get_next_event

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 )

Initializes query statement for the MEMO table to retrieve a resultset by building an AlpDmlStatementH statement handle that selects whatever is specifed by the AlpMemoDmlSelectType from the data model. If the AlpDmlH and AlpDmlStatementH parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. If there are no records in the query, then an ALP_STATUS_MEMO_DML_NO_RECORD is returned. Parameters: [in]  dml  AlpDmlH handle to the Memo data model [in]  memoLuid  AlpLuid optional parameter, to retrieve only data for a specific memo record. [in]  categoryLuid  AlpLuid optional parameter, to determine category of items to be returned. If negative, then the statement will include only "Unfiled" items. If 0, then the statement will include "All" items. Otherwise it will only include items of the category membership requested. [in]  unfiled  bool If true, the categoryLuid is ignored and only records that have no category memberships are retrieved. [out]  stmtH  AlpDmlStatementH handle to query statement that is returned to the caller, and to be used to retrieve the data via calls to alp_memo_dml_statement_next() [in]  selectT  AlpMemoDmlSelectType column/field type for query statement [out]  numResultsP  number of records matching the query statement Returns: alp_status_t See also: alp_memo_dml_statement_next alp_memo_dml_statement_end

alp_status_t alp_memo_dml_statement_copy_string (  AlpDmlStatementH  stmtH, AlpMemoDmlColumnType  column, char **  value )

Deprecated. Use alp_memo_dml_statement_get_int32 instead. Retrieves a string value for a given column from AlpDmlStatementH handle, which holds the resultset from a query. The handle is created by a query API or statement begin API in the data model, for example: alp_memo_dml_statement_begin() If the AlpDmlStatementH or AlpMemoDmlColumnType parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. If an attempt to get the kMemoLUID is made with this routine, an ALP_STATUS_MEMO_DML_RESTRICTED is returned. Parameters: [in]  stmtH  AlpDmlStatementH handle created using any of the query or statement begin APIs in the Memo data model. [in]  column  AlpMemoDmlColumnType enum value of column/field to retrieve [out]  value  string value to be retrieved for the field referenced. The string is copied, and must be freed with free or g_free. Returns: alp_status_t See also: alp_memo_dml_statement_begin alp_memo_dml_statement_next alp_memo_dml_statement_end

alp_status_t alp_memo_dml_statement_end (  AlpDmlStatementH  stmtH  )

Destroys the AlpDmlStatementH handle, which holds the resultset from a query. This is called once the handle or the resultset is of no more use. The handle is created by a query API or statement initialize API in the data model, for example: alp_memo_dml_statement_begin() If the AlpDmlH parameter is invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. Parameters: [in]  stmtH  AlpDmlStatementH handle created using any of the query or statement begin APIs in the Memo data model. Returns: alp_status_t See also: alp_memo_dml_statement_begin alp_memo_dml_statement_next

alp_status_t alp_memo_dml_statement_get_int32 (  AlpDmlStatementH  stmtH, AlpMemoDmlColumnType  column, int32_t *  value )

Retrieves a uint32_t value for a given column from AlpDmlStatementH handle, which holds the resultset from a query. The handle is created by a query API or statement begin API in the data model, for example: alp_memo_dml_statement_begin() If the AlpDmlStatementH or AlpMemoDmlColumnType parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. If an attempt to get the kMemoLUID is made with this routine, an ALP_STATUS_MEMO_DML_RESTRICTED is returned. Parameters: [in]  stmtH  AlpDmlStatementH handle created using any of the query or statement begin APIs in the Memo data model. [in]  column  AlpMemoDmlColumnType enum value of column/field to retrieve [out]  value  uint32_t value to be retrieved for the field referenced Returns: alp_status_t See also: alp_memo_dml_statement_begin alp_memo_dml_statement_next alp_memo_dml_statement_end

alp_status_t alp_memo_dml_statement_get_luid (  AlpDmlStatementH  stmtH, AlpLuid *  memoLuid )

Retrieves a luid value for the given row from AlpDmlStatementH handle, which holds the resultset from a query. The handle is created by a query API or statement begin API in the data model, for example: alp_memo_dml_statement_begin() If the AlpDmlStatementH or AlpLuid parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. Parameters: [in]  stmtH  AlpDmlStatementH handle created using any of the query or statement begin APIs in the Memo data model. [out]  memoLuid  AlpLuid value to be retrieved Returns: alp_status_t See also: alp_memo_dml_statement_begin alp_memo_dml_statement_next alp_memo_dml_statement_end

alp_status_t alp_memo_dml_statement_next (  AlpDmlStatementH  stmtH  )

Iterates the query statement resultset to get the next row of data from the query statement handle and if there is another record pending. If the AlpDmlH parameter is invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. Parameters: [in]  stmtH  AlpDmlStatementH handle to a query statement, used to iterate through the records in the resultset. Returns: alp_status_t See also: alp_memo_dml_statement_begin alp_memo_dml_statement_end

alp_status_t alp_memo_dml_statement_reference_string (  AlpDmlStatementH  stmtH, AlpMemoDmlColumnType  column, char **  value )

Retrieves a string value for a given column from AlpDmlStatementH handle, which holds the resultset from a query. The handle is created by a query API or statement begin API in the data model, for example: alp_memo_dml_statement_begin() If the AlpDmlStatementH or AlpMemoDmlColumnType parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned. If an attempt to get the kMemoLUID is made with this routine, an ALP_STATUS_MEMO_DML_RESTRICTED is returned. Parameters: [in]  stmtH  AlpDmlStatementH handle created using any of the query or statement begin APIs in the Memo data model. [in]  column  AlpMemoDmlColumnType enum value of column/field to retrieve [out]  value  string value to be retrieved for the field referenced. The string is valid until the next DML API call. Returns: alp_status_t See also: alp_memo_dml_statement_begin alp_memo_dml_statement_next alp_memo_dml_statement_end

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.

---

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

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.