Policy Server Guides › Policy Server Configuration Guide › Attributes and Expressions Reference › Functions Available within Expressions › ENUMERATE Function--Test Set Elements

ENUMERATE Function--Test Set Elements

The ENUMERATE function passes each element in the specified set to the named expression specified by the parameter #virtual_user_attribute or @user_class using pasting. If the named expression returns a value, the element is included in the resulting string.

Syntax

The ENUMERATE function has the following format:

ENUMERATE(set, #virtual_user_attribute | @user_class)

Parameters

The ENUMERATE function accepts the following parameters:

set (string)

Specifies a string of elements that are separated by the caret character: 'element1^element2'. Each element is a string.

#virtual_user_attribute (named expression)

Specifies a named expression that calculates a user attribute.

@user_class (named expression)

Specifies a named expression that tests for membership in a user directory or group.

Return Value

The ENUMERATE function returns a string.

Example

Assume that the following statements are true:

• The #virtual_user_attribute is #RTrimset.
• The named expression specified by #RTrimset is the built-in function RTRIM.
• RTRIM accepts one parameter.
• The parameter is represented by the placeholder %0.
• Therefore, #RTrimset := RTRIM(%0).

Return_value=ENUMERATE('First     ^Middle    ^Last      ', #RTrimset)
Return_value='First^Middle^Last'