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

  • IS_GROUP_MEMBER
    Checks a user's membership status within a user group
  • User
    Name of a User object
    Format: script literal or script variable
  • User Group
    Name of a User group
    Format: script literal or script variable

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.

Example

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

See also: