web_set_max_html_param_len

Sets the maximum length of any HTML string that can be retrieved and saved as a parameter.

C Language

int web_set_max_html_param_len( const char *length);

Java Language

int object.set_max_html_param_len( String length);
Argument
Description
object
An expression evaluating to an object of type WebApi. Usually web for Java. See also Function and Constant Prefixes.
length
The maximum length of any HTML string that can be retrieved. Do not enter a length greater than the value of an unsigned integer (4294967295).

Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure.

Parameterization

The following argument(s) can be parameterized using standard parameterization: length

General Information

The web_set_max_html_param_len function is a service function that is used when correlating HTML statements. It is recorded only when correlation during recording is enabled (see VuGen's Recording Options).

The web_set_max_html_param_len function sets the maximum length of any HTML string which VuGen can retrieve and save in a parameter. The default value for the maximum length of a parameter that can be captured during correlation is 256 characters (seeweb_reg_save_param). To retrieve a string longer than 256 characters, use web_set_max_html_param_len to increase the maximum valid length. An attempt to save a string whose length exceeds the maximum length will fail.

This function is supported for all web scripts.