USER-DATA ( ) method

Allows an application to write custom information to a special section at the end of the profiler output file. The data to be written is specified by the parameter value passed to the method call. If successful, USER-DATA() returns TRUE. If it fails to write the data, then it returns FALSE. A failure can occur only if the profiler is unable to open a temporary file. If the value passed is unknown, then a question mark (?) is written; otherwise, the value passed is enclosed in quotation marks. In addition to the string value, the profiler writes an integer value that represents the number of microseconds that elapsed since the start of the profiling process.

Return-type: LOGICAL

Applies to: PROFILER system handle

Syntax

USER-DATA ( string-expression  ) 
string-expression

A string expression to write custom information to a special section at the end of the profiler output file.

See also

WRITE-DATA( ) method