Function

ABGroupAddGroup

Adds a subgroup to another group.

Declaration

bool ABGroupAddGroup(ABGroupRef group, ABGroupRef groupToAdd);

Parameters

group

The group you wish to add a subgroup to. If NULL, this function raises an exception.

groupToAdd

The subgroup you wish to add to group.

Return Value

Returns true if successful. If the group argument is already part of the receiver, this function does nothing and returns false. If adding the group would create a recursion, this function also does nothing and returns false. For example, if the group “Animal Lovers” is in “Dog Lovers,” and you add “Dog Lovers” to “Animal Lovers,” that would create a recursion, which this function won’t allow.

See Also

Groups

ABCopyArrayOfAllGroups

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

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.

ABGroupCopyDistributionIdentifier

Returns the distribution identifier for the given property and person.

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).