Function

ABGroupCopyDistributionIdentifier

Returns the distribution identifier for the given property and person.

Declaration

CFStringRef ABGroupCopyDistributionIdentifier(ABGroupRef group, ABPersonRef person, CFStringRef property);

Parameters

group

The group object that person belongs to.

person

A person object whose distribution identifier you want to obtain.

property

The name of a person’s multi-value list property whose distribution identifier you want to obtain.

Return Value

The distribution identifier for person and property if it was set, otherwise returns the property’s primary identifier. If either person or property are NULL, this function returns NULL. Also, returns NULL if property is not a multi-value list property. You are responsible for releasing this object.

Discussion

Use the ABGroupSetDistributionIdentifier function to set the distribution identifier for a person’s multi-value list property.

See Also

Groups

ABCopyArrayOfAllGroups

Returns an array of all the groups in the Address Book database.

ABGroupAddGroup

Adds a subgroup to another group.

ABGroupAddMember

Adds a person to a group.

ABGroupCopyArrayOfAllMembers

Returns an array of persons in a group.

ABGroupCopyArrayOfAllSubgroups

Returns an array containing a group’s subgroups.

ABGroupCopyParentGroups

Returns an array containing a group’s parents—the groups that a group belongs to.

ABGroupCreate

Returns a new ABGroup object.

ABGroupCreateSearchElement

Creates an ABSearchElement object that specifies a query for ABGroup records.

ABGroupRemoveGroup

Removes a subgroup from a group.

ABGroupRemoveMember

Removes a person from a group.

ABGroupSetDistributionIdentifier

Assigning a specific distribution identifier for a person’s multi-value list property so that the group can be used as a distribution list (mailing list, in the case of an email property).