Distribution List Membership
[API's]


Defines

#define alp_contacts_dml_distribution_memberships_add   alp_contacts_dml_distribution_add_memberships
#define alp_contacts_dml_distribution_memberships_remove   alp_contacts_dml_distribution_remove_memberships

Functions

alp_status_t alp_contacts_dml_distribution_add_memberships (AlpDmlH dmlH, AlpLuid contactID, const AlpLuid *distributionLuids, int32_t numDistributionLuids)
 Adds the given contact ID to the given distribution lists.
alp_status_t alp_contacts_dml_distribution_membership_statement_begin (AlpDmlH dmlH, AlpLuid contactID, AlpLuid distributionLuid, AlpContactsDmlDistributionMembershipOrderByType orderBy, AlpDmlStatementH *distMembershipStmtH, int32_t *numResults)
 Creates and initializes a new AlpDmlStatementH that can be used to iterate over the distribution list memberships.
alp_status_t alp_contacts_dml_distribution_remove_memberships (AlpDmlH dmlH, AlpLuid contactID, const AlpLuid *distributionLuids, int32_t numDistributionLuids)
 Removes a given contact ID from a set of distribution lists.

Define Documentation

#define alp_contacts_dml_distribution_memberships_add   alp_contacts_dml_distribution_add_memberships
 

#define alp_contacts_dml_distribution_memberships_remove   alp_contacts_dml_distribution_remove_memberships
 

Function Documentation

alp_status_t alp_contacts_dml_distribution_add_memberships (  AlpDmlH  dmlH,
AlpLuid  contactID,
const AlpLuid *  distributionLuids,
int32_t  numDistributionLuids
) 
 

Adds the given contact ID to the given distribution lists.

This routine validates that the contactID represents a valid contact entity in the datamodel, and returns ALP_STATUS_CONTACTS_DML_BAD_PARAM if it does not.

This routine validates that the contact ID represents a valid contact for the distribution list type and returns ALP_STATUS_CONTACTS_DML_INVALID_TYPE if it does not.

Parameters:
[in] dmlH Contacts data model handle
[in] contactID ID of contact to add to distribution lists
[in] distributionLuids Luids of distribution lists to add to
[in] numDistributionLuids Number of Luids in distributionLuids array
Returns:
ALP_STATUS_CONTACTS_DML_* error

alp_status_t alp_contacts_dml_distribution_membership_statement_begin (  AlpDmlH  dmlH,
AlpLuid  contactID,
AlpLuid  distributionLuid,
AlpContactsDmlDistributionMembershipOrderByType  orderBy,
AlpDmlStatementH *  distMembershipStmtH,
int32_t *  numResults
) 
 

Creates and initializes a new AlpDmlStatementH that can be used to iterate over the distribution list memberships.

The fields fetched are: Identifier - Contact identifier Value - Contact value ContactType - Contact type ContactID - Contact ID

Use alp_contacts_dml_statement_get_luids to get the person luid and distribution list luid.

After calling this routine, you must call alp_contacts_dml_statement_next() to advance the statement to the first object in the result set before you can call any of the alp_contacts_dml_statement_get_* API to retrieve information from an object.

It is important to keep track of which alp_contact_dml_*_statement_init function you use to initialize which AlpDmlStatementH, because that will dictate which objects are included in the statement's result set, and what AlpContactsDmlColumnType's you can use to fetch values from items in the statement.

If there are no records found that match the search critereon ALP_STATUS_CONTACTS_DML_NO_RECORDS will be returned, and the distMembershipStmtH parameter will not be initialized (so the caller should not call alp_contacts_dml_statement_next (or end) on it.

Parameters:
[in] dmlH Handle to the Contacts data model
[in] contactID This optional parameter specifies a contact ID filter to use when building the statement handle. If non-zero it will only include items that have this contact ID.
[in] distributionLuid This optional parameter specifies a distribution list luid filter to use when building the statement handle. If non-zero it will only include items that have this distribution list luid.
[in] orderBy An enum specifying how the items in the statement handle are to be sorted
[out] distMembershipStmtH The address of a statement handle that is to be allocated and initialized by this routine. This parameter is optional, and if NULL, this value won't be computed or set.
[out] numResults Pointer to an integer that will be used to store the number of ContactItems found matching the filter parameters supplied. This parameter is optional, and if NULL, this value won't be computed or set.
Returns:
ALP_STATUS_CONTACTS_DML_* error

alp_status_t alp_contacts_dml_distribution_remove_memberships (  AlpDmlH  dmlH,
AlpLuid  contactID,
const AlpLuid *  distributionLuids,
int32_t  numDistributionLuids
) 
 

Removes a given contact ID from a set of distribution lists.

If distributionLuids is NULL, then the contactID's membership is removed from ALL distribution lists (this is useful when deleting a person from the datamodel).

Parameters:
[in] dmlH Contacts data model handle
[in] contactID ID of contact to remove from distribution lists. If 0 then all members of the distribution lists are removed.
[in] distributionLuids Luids of distribution lists to remove from. If NULL, contact is removed from all distribution lists
[in] numDistributionLuids Number of Luids in distributionLuids 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.