Memo Database Write API
[Data Model API's]


Functions

alp_status_t alp_memo_dml_delete (AlpDmlH dmlH, AlpLuid memoLuid)
alp_status_t alp_memo_dml_insert (AlpDmlH dmlH, AlpDmlItemH memoH, AlpLuid *memoLuid)
alp_status_t alp_memo_dml_update (AlpDmlH dmlH, AlpDmlItemH memoH, AlpLuid memoLuid)

Function Documentation

alp_status_t alp_memo_dml_delete (  AlpDmlH  dmlH,
AlpLuid  memoLuid
) 
 

Deletes an existing memo record from the MEMO table of the MEMO database. Once the memo was deleted, the _CATEGORY_MEMBERSHIP table must be updated by calling alp_memo_dml_remove_memberships().

If the AlpDmlH parameter is invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned.

If the AlpLuid parameter is invalid, an ALP_STATUS_MEMO_DML_INVALID_LUID is returned.

Parameters:
[in] dmlH AlpDmlH handle to the Memo data model
[in] memoLuid AlpLuid of the memo to be deleted
Returns:
alp_status_t
See also:
alp_memo_dml_remove_memberships

alp_status_t alp_memo_dml_insert (  AlpDmlH  dmlH,
AlpDmlItemH  memoH,
AlpLuid *  memoLuid
) 
 

Inserts a new memo record into the MEMO table of the MEMO database. On success, a new AlpLuid will be returned in the memoLuid parameter. After a memo is inserted into the MEMO table it must be also inserted into the _CATEGORY_MEMBERSHIP table using the AlpLuid calling alp_memo_dml_add_memberships().

If the AlpDmlH, AlpDmlItemH, AlpLuid parameters are invalid, an ALP_STATUS_MEMO_DML_INVALID_PARAMETER is returned.

Parameters:
[in] dmlH AlpDmlH handle to the Memo data model
[in] memoH AlpDmlItemH handle containing pointer to memo data and information
[in/out] memoLuid AlpLuid pointer to return newly inserted memo or pass in a valid luid to be inserted into the database.
Returns:
alp_status_t
See also:
alp_memo_dml_add_memberships

alp_status_t alp_memo_dml_update (  AlpDmlH  dmlH,
AlpDmlItemH  memoH,
AlpLuid  memoLuid
) 
 

Updates an existing memo record into the MEMO table of the MEMO database.

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

If the AlpLuid parameter is invalid, an ALP_STATUS_MEMO_DML_INVALID_LUID is returned.

Parameters:
[in] dmlH AlpDmlH handle to the Memo data model
[in] memoH AlpDmlItemH handle containing pointer to memo data and information
[in] memoLuid AlpLuid of the memo being updated
Returns:
alp_status_t

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.