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.group.addMember

Adds a person to a group.

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

MBS( "Addressbook.group.addMember"; GroupID; PersonID )

Parameters

Parameter Description Example value
GroupID The unique ID for the target group. $groupID
PersonID The unique ID for the person to be added to the group. $personID

Result

Returns 1 for success or 0 for failure on Mac. Returns OK on success and error on failure on iOS.

Description

Adds a person to a group.
If the person argument is already part of the group, this method does nothing and returns OK.
Prior to OS X v10.6, if the person record is already in the group, this method does nothing and returns failure.

Examples

Add person to group:

# add to group
Set Variable [ $r ; Value: MBS( "Addressbook.group.addMember"; "Best Friends"; $PersonID ) ]
# save changes
Set Variable [ $r ; Value: MBS( "Addressbook.save"; $personID ) ]

See also


Addressbook.formattedAddress   -   Addressbook.group.addSubgroup

Feedback: Report problem or ask question.




Links
MBS Xojo blog