#ToolsRel function

Syntax

#ToolsRel

Description

Use the #ToolsRel function to return a string value representing the current PeopleTools release in the following format:

PT_major_rel.PT_minor_rel.patch_level

Use the #ToolsRel function in a directive expression to compare the return value to a literal string. Similar to the value returned by the #ToolsRel function, this literal string must be specified in the following format:

PT_major_rel.PT_minor_rel[.patch_level]

When the literal string contains the optional patch level, the comparison is performed to the patch level in the directive expression. However, if the literal string does not specify the optional patch level, the comparison is performed to the release level in the directive expression. Therefore, because the comparison is performed to the release level only, the following directive expression evaluates to True when the current PeopleTools release is 8.54.00, 8.54.01, 8.54.02, and so on:

#ToolsRel = "8.54"

Parameters

None.

Returns

A String value.

Considerations for Directive Expressions

Directive expressions are logical expressions evaluated before compile time. They are always provided between the #If and #Then directive keywords. Directive expressions use directive functions and regular PeopleCode comparison operators for evaluating the directive expressions.

Important:

Directive functions can be used in conjunction with directives in directive expressions only. Using a directive function anywhere else will result in a compile time error.