Web Vuser Functions (WEB) > Alphabetical List of Web Vuser Functions > web_stream_get_param_string

web_stream_get_param_string

Gets the state of the stream and saves it in a parameter.

C Language

int web_stream_get_param_string( const char *StreamID, const int StateType, const char *ParameterName );

Example Stream Functions

Argument Description
StreamID The identifier passed to web_stream_open.
StateType

One of:

  • STREAM_URL (7)
  • PROTOCOL (8)
  • SERVER_IP (9)
ParameterName The parameter to store the state string.

Return Values

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

Parameterization

Standard parameterization is not available for this function.

General Information

The web_stream_get_param_string function returns the state of the open stream.

This function is not recorded. You can insert it manually into your script.

Example

This is an example of a the use of web_stream_get_param_string:

web_stream_get_param_string("2", STREAM_URL, "StreamURL");
web_stream_get_param_string("2", PROTOCOL, "StreamProtocol");
web_stream_get_param_string("2", SERVER_IP, "ServerIP");
lr_output_message("Url: , %s", lr_eval_string("{StreamURL}"));
lr_output_message("Protocol: , %s",lr_eval_string("{StreamProtocol}"));
lr_output_message("IP:, %s",lr_eval_string("{ServerIP}"));