IS_GROUP_MEMBER

Use the IS_GROUP_MEMBER script function to check the membership status of a user within a user group. Both the user and the user group must be available in the client in which they are called.

Syntax

IS_GROUP_MEMBER (User, User Group)

Parameters

Parameter	Description	Format	Allowed Values	Default Value
User	Defines the name of a User object.	Script literal or script variable	n.a.	n.a.
User Group	Defines the name of a User group.	Script literal or script variable	n.a.	n.a.

Return Codes

The IS_GROUP_MEMBER script function has the following return codes:

1

The user is a member of the user group.
0

The user is not a member of the user group, or the user and/or the user group do(es) not exist.

Examples

The following example tests the membership status of "BU/AE" within the user group "ADMIN". The result is written to 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