Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

Addressbook.groups

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

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
Addressbook 3.1 Yes No Yes, macOS only No Yes

MBS( "Addressbook.groups" { ; Account } )

Parameters

Parameter Description Example value
Account Optional
The account identifier to limit search for.
_local

Result

Returns list of group IDs.

Description

Returns an array of all the groups in the Address Book database.
If the database doesn't contain any groups, this method returns an empty array.

You can use Addressbook.record.displayname to find the display name of a group. Or you query the group name property with Addressbook.record.valueForProperty.

Examples

Query list of group IDs:

MBS( "Addressbook.groups" )

Query display name of first group:

MBS( "Addressbook.record.displayname"; ElementLeft ( MBS( "Addressbook.groups" ) ; 1 ))

See also


Addressbook.group.subgroups   -   Addressbook.hasUnsavedChanges

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins