lr.user_data_point

Records a user-defined data sample.

JavaScript

function lr.user_data_point(sample_name,value)

VBScript

Function lr.user_data_point(sample_name,value)
Example: lr.user_data_pointInformational Functions

Arguments

NameComments
sample_nameThe data point name.
valueThe value to record.

The lr.user_data_point function allows you to record your own data for analysis. Each time you want to record a point, use this function to record the sample name and the value. The time of the sample is recorded automatically. After the execution, you can use the User Defined Data Points graph to analyze the results.

The following prefixes in sample_name are reserved:

  • HTTP
  • NON_HTTP
  • RETRY
  • mic_
  • stream_
  • mms_

A data point with any of these prefixes, for example "HTTP_BT", will not appear on the graph. However, the prefixes are case-sensitive, therefore "http_BT" is a valid sample_name.

Return Values

Returns 0 on success and -1 on failure.

Parameterization

All string input arguments can be passed using standard parameterization.