Write Item
[Category Manager API's]


Functions

alp_status_t alp_catmgr_dml_delete (AlpDmlH dmlH, AlpCatMgrDmlItemType itemType, AlpLuid itemLuid)
alp_status_t alp_catmgr_dml_insert (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid *itemLuid)
alp_status_t alp_catmgr_dml_update (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid itemLuid)

Function Documentation

alp_status_t alp_catmgr_dml_delete (  AlpDmlH  dmlH,
AlpCatMgrDmlItemType  itemType,
AlpLuid  itemLuid
) 
 

Deletes an item from the datamodel indicated by a luid that was created with alp_catmgr_dml_item_create.

Parameters:
[in] dmlH Handle to the CatMgr Datamodel
[in] itemType AlpCatMgrDmlItemType of the item to be deleted
[in] itemLuid Luid for the item to be deleted.
Returns:
ALP_STATUS_CATMGR_DML_* error

alp_status_t alp_catmgr_dml_insert (  AlpDmlH  dmlH,
AlpDmlItemH  itemH,
AlpLuid *  itemLuid
) 
 

Inserts a given item into the datamodel. The itemH must have been created with alp_catmgr_dml_item_create with a valid AlpCatMgrDmlItemType. If the insert is successful, a new AlpLuid will be returned in the luid parameter.

Note in the case that itemH is a MembershipItem, the luid parameter will be validated to make sure a corresponding category luid has already been inserted.

Parameters:
[in] dmlH Handle to the CatMgr Datamodel
[in] itemH AlpDmlItemH to be inserted
[in/out] luid If itemH is a CategoryItem, the output is the new category luid created, upon successful insertion. If itemH is a MembershipItem, upon successful insertion, the output is the new membership luid created. Or it can be a valid luid for category or membership to be inserted into the database.
Returns:
ALP_STATUS_CONTACTS_DML_* error

alp_status_t alp_catmgr_dml_update (  AlpDmlH  dmlH,
AlpDmlItemH  itemH,
AlpLuid  itemLuid
) 
 

Updates a given CategoryItem in the datamodel. The itemH must have been created with alp_catmgr_dml_item_create.

categoryLuid must be a valid Luid for a CategoryItem that has already been inserted into the datamodel with alp_catmgr_dml_insert.

If the Luid doesn't exist in the datamodel ALP_STATUS_CATMGR_DML_INVALID_LUID is returned.

After updating, all fields in the old item are overwritten fields from the new item.

Parameters:
[in] dmlH Handle to the CatMgr Datamodel
[in] itemH Handle to an item created with alp_catmgr_dml_item_create
[in] categoryLuid Luid for the item that was inserted with alp_catmgr_dml_insert
Returns:
ALP_STATUS_CATMGR_DML_* error

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.