JavaScript Functions > Alphabetical Listing of Web Functions > web.regSaveParamAttrib

web.regSaveParamAttrib

Example Correlation Functions for JavaScript

Registers a request to save dynamic data in a server response that has been formatted as HTML. The data is saved to a parameter.

Syntax

web.regSaveParamAttrib( {object} );

JavaScript Object

{

paramName: "<string>",

tagName: "<string>",

extract: "<string>",

name: "<string>",

id: "<string>",

class: "<string>",

type: "<string>",

DFEs: "<string>",

notFound: "<string>",

contentType: "<string>",

selectAll: "<string>",

ordinal: "<string>",

ignoreRedirections: "<string>",

relFrameID: "<string>",

requestURL: "<string>"

}

Argument Description
ParamName The name of the parameter to create.
TagName The name of HTML element.
Extract The name of HTML attribute whose value will be saved to parameter.
Name The value of the HTML element's "name” attribute.
Id The value of the HTML element's “id” attribute.
Class The value of the HTML element's “class” attribute.
Type

The value of the HTML element's “type” attribute.

For example, for the INPUT element, Type can be "hidden".

List of Attributes

For details of each attribute, see Attributes for Save Parameter Registration Functions. Attribute value strings (e.g., "NotFound=warning") are not case-sensitive. See the Restrictions.

SEARCH FILTERS

Specifies the sections of the buffer to search for the data in. See Search Filters for Save Parameter Registration Functions

See the Restrictions.

LAST A marker that indicates the end of the argument list.

Return Values

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

Restrictions

For more information on the DFEs argument, see Attributes for Save Parameter Registration Functions.

For more information on the headernames and scope arguments, see Search Filters for Save Parameter Registration Functions

For more information on the relframeid and selectAll arguments, see Search Filters for Save Parameter Registration Functions and relframeid Attribute.

Scope is not supported.

Example

/*Correlation comment - Do not change!  
Original value='pmFnLi8R6qjCQh0E66dNyFE6EGkZFDBPRmeCBNNQCewvn6R2ez95zCZxL' Name ='session_id' Type ='ResponseBased'*/
web.regSaveParamAttrib(
	{
	  paramName : 'mySession',
	  tagName : 'INPUT',
	  extract : 'VALUE',
	  name : 'session_id',
	  type : 'HIDDEN',
	  ignoreRedirections : 'No'
	}
);