Category Membership
[API's]


Functions

alp_status_t alp_contacts_dml_add_memberships (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryLuids, AlpLuid membershipLuid, int32_t numCategoryLuids)
 Adds the given personLuid to the given categories.
alp_status_t alp_contacts_dml_memberships_add (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryIDs, AlpLuid membershipLuid, int32_t numCategoryIDs) __attribute((deprecated))
 Deprecated. Use alp_contacts_dml_add_memberships instead.
alp_status_t alp_contacts_dml_memberships_remove (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryIDs, AlpLuid membershipLuid, int32_t numCategoryIDs) __attribute((deprecated))
 Deprecated. Use alp_contacts_dml_remove_memberships instead.
alp_status_t alp_contacts_dml_remove_memberships (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryLuids, AlpLuid membershipLuid, int32_t numCategoryLuids)
 Removes a given personLuid's membership from a set of categories.

Function Documentation

alp_status_t alp_contacts_dml_add_memberships (  AlpDmlH  dmlH,
AlpLuid  personLuid,
const AlpLuid *  categoryLuids,
AlpLuid  membershipLuid,
int32_t  numCategoryLuids
) 
 

Adds the given personLuid to the given categories.

Note, this routine validates that the personLuid represents a valid person entity in the datamodel, and returns ALP_STATUS_CONTACTS_DML_BAD_PARAM if it does not.

Parameters:
[in] dmlH Contacts data model handle
[in] personLuid Luid of person to add to categories
[in] categoryLuids Luids of categories the person is to be added to
[in] membershipLuid Luid of membership to add to categories (optional)
[in] numCategoryLuids Number of Luids in categoryLuids array
Returns:
ALP_STATUS_CONTACTS_DML_* error

alp_status_t alp_contacts_dml_memberships_add (  AlpDmlH  dmlH,
AlpLuid  personLuid,
const AlpLuid *  categoryIDs,
AlpLuid  membershipLuid,
int32_t  numCategoryIDs
) 
 

Deprecated. Use alp_contacts_dml_add_memberships instead.

alp_status_t alp_contacts_dml_memberships_remove (  AlpDmlH  dmlH,
AlpLuid  personLuid,
const AlpLuid *  categoryIDs,
AlpLuid  membershipLuid,
int32_t  numCategoryIDs
) 
 

Deprecated. Use alp_contacts_dml_remove_memberships instead.

alp_status_t alp_contacts_dml_remove_memberships (  AlpDmlH  dmlH,
AlpLuid  personLuid,
const AlpLuid *  categoryLuids,
AlpLuid  membershipLuid,
int32_t  numCategoryLuids
) 
 

Removes a given personLuid's membership from a set of categories.

If categoryLuids is NULL, then the personLuid's membership is removed from ALL categories (this is useful when deleting a person from the datamodel).

Note, this routine validates that the personLuid represents a valid person entity in the datamodel, and returns ALP_STATUS_CONTACTS_DML_BAD_PARAM if it does not.

Parameters:
[in] dmlH Contacts data model handle
[in] personLuid Luid of person to add to categories
[in] categoryLuids Luids of categories the person is to be removed from. If NULL, person is removed from all categories
[in] membershipLuid Luid of membership to add to categories (optional)
[in] numCategoryLuids Number of Luids in categoryLuids array
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.