Transformer Pipeline Module API Reference  7.1.19.190859-2c068f14
Format Module: Global Pipeline Functions (deprecated)

Detailed Description

The format module if loaded exposes some methods to pipelines to enable formatting of strings.

Note
The methods are only available if the format module is loaded.

Functions

 format (var format_string, var text_to_format)
 Format a string according to the specified format parameter. More...
 
 format_validate (var format_string)
 Validate a format string. More...
 

Function Documentation

format ( var  format_string,
var  text_to_format 
)

Format a string according to the specified format parameter.

Parameters
format_string- Format specification to apply
text_to_format- The text that should be formatted
Returns
Formatted text
Note
The format specifiers are defined within the Transformer SDK documentation
Deprecated:
Use formatter.format() instead.
format_validate ( var  format_string)

Validate a format string.

Parameters
format_string- Format string to validate
Return values
0- Format is valid
-1- Format is invalid
Note
The format specifiers are defined within the Transformer SDK documentation
Deprecated:
Use formatter.validate() instead.

Generated on Fri Jan 12 2024 14:49:15 for Transformer Pipeline Module API Reference