Automation Engine Script Guide > Ordered by Function > User Data > IS_GROUP_MEMBER

IS_GROUP_MEMBER

Script Function: Checks a user's membership status within a user group

Syntax

IS_GROUP_MEMBER (User, UserGroup)

Syntax	Description/Format
User	Name of a User object Format: script literal or script variable
UserGroup	Name of a UserGroup object Format: script literal or script variable

Return codes
"1" - The user is a member of the user group "0" - The user is no member of the user group or the user and/or the user group do(es) not exist.

Comments

The membership status of a user within a user group may be checked using this script function. Both must be in the client in which this script function is called.

Example

In this example, the membership status of "BU/AE" within the user group "ADMIN" is tested. The result is written out in the activation report.

:SET &USGR#   = "ADMIN"
:SET &MEMBER# = IS_GROUP_MEMBER("BU/AE", &USGR#)
:IF &MEMBER# = 1
:   PRINT "Member in &USGR#"
:ELSE
:   PRINT "No member in &USGR#"
:ENDIF