Memo Creation API
[Data Model API's]


Functions

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.

Function Documentation

alp_status_t alp_memo_dml_item_create (  AlpDmlItemH *  memoH  ) 
 

Allocates and returns a AlpMemoH handle. If the call fails, it will return NULL. Hence the application should check for NULL prior to attempting to use the handle.

If there is not enough memory available to allocate space for a memo data structure, an ALP_STATUS_MEMO_DML_NO_MEMORY will be returned.

Parameters:
[out] memoH AlpMemoH handle to a new memo structure
Returns:
alp_status_t
See also:
alp_memo_dml_item_destroy

alp_status_t alp_memo_dml_item_destroy (  AlpDmlItemH  memoH  ) 
 

Frees memory used to store an AlpMemoType data structure. Using the address of the pointer passed, it destroys all the memory in the data structure. Sets the handle to NULL.

Parameters:
[in] memoH AlpMemoH handle to a AlpMemoType data structure
See also:
alp_memo_dml_item_create

alp_status_t alp_memo_dml_item_set_int32 (  AlpDmlItemH  memoH,
AlpMemoDmlColumnType  column,
const int32_t *  value
) 
 

Sets the value in memo data structure referenced by the handle and column passed.

If the AlpDmlItemH or AlpMemoDmlColumnType parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned.

If an attempt to set the kMemoLUID is made, an ALP_STATUS_MEMO_DML_RESTRICTED is returned.

Parameters:
[in] memoH AlpDmlMemo handle to a referenced memo data structure
[in] column AlpMemoDmlColumnType enum value of column/field to be set
[in] value uint32_t value to be stored in the field of the referenced memo data structure or NULL to unset the field
Returns:
alp_status_t
See also:
alp_memo_dml_item_set_string

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.

Sets a string member in the memo data structure referenced by the handle and column passed.

If the AlpDmlItemH or AlpMemoDmlColumnType parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned.

If an attempt to set the kMemoLUID is made, an ALP_STATUS_MEMO_DML_RESTRICTED is returned.

Parameters:
[in] memoH AlpDmlItemHandle handle to a referenced memo data structure
[in] column AlpMemoDmlColumnType enum value of column/field to be set
[in] value string value to be stored in the field of the referenced memo data structure
Returns:
alp_status_t
See also:
alp_memo_dml_item_set_uint32

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.