Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Policy Methods › ExcludeUser Method—Excludes or Includes a User from the Policy

ExcludeUser Method—Excludes or Includes a User from the Policy

The ExcludeUser method excludes or includes a user from the policy depending on the value of iExcludeFlag.

Syntax

The ExcludeUser method has the following format:

Netegrity::PolicyMgtPolicy‑>ExcludeUser(user[, iExcludeFlag])

Parameters

The ExcludeUser method accepts the following parameters:

user (PolicyMgtUser)

Specifies the user to exclude or include.

iExcludeFlag (int)

(Optional) Specifies whether to exclude the specified user:

• 1 to exclude the user
• 0 to include the user

If this argument is not passed, the function returns the current value of iExcludeFlag.

Return Value

The ExcludeUser method returns one of the following values:

• 0 if the user is included successfully.
• 1 if the user is excluded successfully.
• -1 if the call is unsuccessful