Membership Functions
[Category Manager API's]


Defines

#define alp_catmgr_dml_memberships_add   alp_catmgr_dml_add_memberships
#define alp_catmgr_dml_memberships_remove   alp_catmgr_dml_remove_memberships

Functions

alp_status_t alp_catmgr_dml_add_memberships (AlpDmlH catDmlH, AlpLuid entityID, const AlpLuid *categoryIDs, AlpLuid membershipID, int32_t numCategoryIDs)
alp_status_t alp_catmgr_dml_remove_memberships (AlpDmlH catDmlH, AlpLuid entityID, AlpLuid categoryID, AlpLuid membershipID)

Define Documentation

#define alp_catmgr_dml_memberships_add   alp_catmgr_dml_add_memberships
 

#define alp_catmgr_dml_memberships_remove   alp_catmgr_dml_remove_memberships
 

Function Documentation

alp_status_t alp_catmgr_dml_add_memberships (  AlpDmlH  catDmlH,
AlpLuid  entityID,
const AlpLuid *  categoryIDs,
AlpLuid  membershipID,
int32_t  numCategoryIDs
) 
 

Inserts entity into the given categories for the given datamodel.

Warning: There is no protection against duplicate memberships

Parameters:
[in] catDmlH Handle containing data model to modify
[in] entityID The AlpLuid for the data model entity who's membership is being added
[in] categoryIDs Array of AlpLuid's for which the entity is to become a member.
[in] membershipID The AlpLuid for a membership being added. (optional)
[in] numCategoryIDs Number of AlpLuid's in categoryIDs array.
Returns:
alp_status_t

alp_status_t alp_catmgr_dml_remove_memberships (  AlpDmlH  catDmlH,
AlpLuid  entityID,
AlpLuid  categoryID,
AlpLuid  membershipID
) 
 

Removes one or all memberships to the given category for a certain entity of a given datamodel.

Warning: There is no checking or error notification to ensure that an entity actually has membership in the given categoryID before attempting to remove the membership.

Parameters:
[in] catDmlH Handle containing data model to modify
[in] entityID The AlpLuid for the data model entity who's membership is being removed
[in] categoryID AlpLuid for the category which is to be removed for the entity.
[in] membershipID The AlpLuid for a membership being removed. (optional)
[in] all A flag indicating whether the entity's membership should be removed for all categories. If true, the categoryID parameter is ignored.
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.