FMX.AddressBook.TCustomAddressBook.AllContactsInGroup

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure AllContactsInGroup(const AGroup: TAddressBookGroup; var AContacts: TAddressBookContacts);

C++

void __fastcall AllContactsInGroup(TAddressBookGroup* const AGroup, TAddressBookContacts* &AContacts);

Properties

Type Visibility Source Unit Parent
procedure
function
public
FMX.AddressBook.pas
FMX.AddressBook.hpp
FMX.AddressBook TCustomAddressBook

Description

Gets a list of all contacts that belong to the specified group.

Use this method to get a list of all contacts from the specified group AGroup.

Examples

To clarify, consider the following examples. These code snippets illustrate how to list all contacts from the specified group.

Delphi:

var
  GroupContacts: TAddressBookContacts;
  Group: TAddressBookGroup;
  i: Integer;
  s: String;
begin
  // The Group object should be defined earlier
  GroupContacts := TAddressBookContacts.Create;
  try
    // Get all contacts from the Group group
    AddressBook1.AllContactsInGroup(Group, GroupContacts);
    s := 'Contacts from the ' + Group.Name + ' group:' + sLineBreak;
    for i := 0 to GroupContacts.Count - 1 do
      s := s + GroupContacts.Items[i].DisplayName + sLineBreak;
    ShowMessage(s);
  finally
    GroupContacts.Free;
  end;
end;

C++Builder:

        TAddressBookGroup *Group;
	TAddressBookContacts *GroupContacts;
	int i;
	// The Group object should be defined earlier
	GroupContacts = new TAddressBookContacts();
	__try {
		// Get all contacts from the Group group.
		AddressBook1->AllContactsInGroup(Group, GroupContacts);
		UnicodeString s = "Contacts from the " + Group->Name + " group:" +
			sLineBreak;
		for (i = 0; i < GroupContacts->Count; i++) {
			s = s + GroupContacts->Items[i]->DisplayName + sLineBreak;
		}
		ShowMessage(s);
	}
	__finally {
		GroupContacts->Free();
	}



For more information and samples, see Mobile Tutorial: Using an Address Book Component (iOS and Android).

See Also