Write Item
[API's]


Functions

alp_status_t alp_contacts_dml_delete (AlpDmlH dmlH, AlpContactsDmlItemType itemType, AlpLuid itemLuid)
 Deletes an item from the datamodel indicated by personLuid that was created with alp_contacts_dml_item_create.
alp_status_t alp_contacts_dml_insert (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid *itemLuid)
 Inserts a given item into the datamodel.
alp_status_t alp_contacts_dml_update (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid itemLuid)
 Updates a given item in the datamodel.


Function Documentation

alp_status_t alp_contacts_dml_delete AlpDmlH  dmlH,
AlpContactsDmlItemType  itemType,
AlpLuid  itemLuid
 

Deletes an item from the datamodel indicated by personLuid that was created with alp_contacts_dml_item_create.

Note that in the cases of deleting a PersonItem, all items related to that person, ie, all items of type ExtraFieldItem, AddressItem, and ContactItem that have the same personLuid are also deleted.

If the dml was opened without changeTrackingOn true then ALP_STATUS_CONTACT_DML_NO_CHANGE_TRACKING_ERROR will be returned.

Parameters:
[in] dmlH Handle to the Contacts Datamodel
[in] itemType AlpContactsDmlItemType of the item to be deleted
[in] itemLuid Luid for the item to be deleted.
Returns:
ALP_STATUS_CONTACTS_DML_* error

alp_status_t alp_contacts_dml_insert AlpDmlH  dmlH,
AlpDmlItemH  itemH,
AlpLuid itemLuid
 

Inserts a given item into the datamodel.

The itemH must have been created with alp_contacts_dml_item_create with a valid AlpContactsDmlItemType. If the insert is successful, a new AlpLuid will be returned in the personLuid parameter.

Only those fields marked as "dirty" will be written; all other fields will be untouched. The "dirty" flag is cleared on successful inserts.

Note in the case that itemH is a ContactItem, ExtraFieldItem, or AddressItem, the personLuid parameter will be validated to make sure a corresponding personLuid has already been inserted.

Note, that there is protection against inserting multiple items with the same Identifier.

If the dml was opened without changeTrackingOn true then ALP_STATUS_CONTACT_DML_NO_CHANGE_TRACKING_ERROR will be returned.

Parameters:
[in] dmlH Handle to the Contacts Datamodel
[in] itemH Handle to an item created with alp_contacts_dml_item_create
[in,out] itemLuid If itemH is a PersonItem then this parameter will be set to the new AlpLuid for the person inserted in the datamodel, if the insertion is successful.
If itemH is a DistributionItem then this parameter will be set to the new AlpLuid for the distribution list inserted in the datamodel, if the insertion is successful.

If itemH is a ContactItem, ExtraFieldItem, or AddressItem, the caller should set the parameter to the Luid of the PersonItem for which the item is to be assocated with and on the way out, this value will be replaced with the AlpLuid of the item created.

If itemH is a ThumbnailItem, the caller hould set the parameter to the Luid of the PersonItem or DistributionItem for which the item is to be assocated with and on the way out, this value will be replaced with the AlpLuid of the item created.

Returns:
ALP_STATUS_CONTACTS_DML_* error

alp_status_t alp_contacts_dml_update AlpDmlH  dmlH,
AlpDmlItemH  itemH,
AlpLuid  itemLuid
 

Updates a given item in the datamodel.

The itemH must have been created with alp_contacts_dml_item_create with a valid AlpContactsDmlItemType. entityLuid must be a valid Luid for an Item that has already been inserted into the datamodel with alp_contacts_dml_insert. If the Luid doesn't exist in the datamodel ALP_STATUS_CONTACTS_DML_INVALID_LUID is returned.

Only those fields marked as "dirty" will be written; all other fields will be untouched. The "dirty" flag is cleared on successful inserts.

If the dml was opened without changeTrackingOn true then ALP_STATUS_CONTACT_DML_NO_CHANGE_TRACKING_ERROR will be returned.

ALP_STATUS_CONTACT_DML_CHANGEMGR_CONFLICT wil be returned if a monitor was acquired and there was a conflict.

Parameters:
[in] dmlH Handle to the Contacts Datamodel
[in] itemH Handle to an item created with alp_contacts_dml_item_create
[out] itemLuid Luid for the item to be updated.
Returns:
ALP_STATUS_CONTACTS_DML_* error


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

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