Web Vuser Functions (WEB) > General Topics in Web Protocol > RelFrameID Attribute

RelFrameID Attribute

The RelFrameID attribute represents the frame ID of the current HTML page relative to the requested URL. RelFrameID is not supported in GUI level scripts.

In Web scripts, a Relative Frame ID is specified as a dot–delimited sequence of decimal integers also known as qualifiers. You can specify a maximum of seven qualifiers, each qualifier ranging from 1 to 15. Zero is not a valid qualifier for a Relative Frame ID. The first qualifier is always 1, implying the first HTML page that is referenced (as a frame) by the requested URL. The next qualifier denotes the index of the next requested page. The following section shows a sample hierarchy:

  1. the requested URL

  2. the first HTML page referenced as a frame by the requested URL

  3. the second HTML page referenced as a frame by the requested URL

  4. the first HTML page referenced by the 1.2 page.

The following guidelines apply to Relative Frame IDs:

Note: It is not recommended to refer directly to a specific occurrence (e.g., "Tags_9" or "Tags_21"). The order of occurrences may not be constant between runs, so that referring directly to a specific occurrence may yield a different value for each run. There may also be other ambiguous cases. Instead of referring to a specific occurrence, loop through the returned values to locate the value in which you are interested.

Use Ord=ALL to search all saved values, not specific occurrences.

Defaults

If the RelFrameID attribute is not specified (or cannot be specified, as in web_create_html_param and web_create_html_param_ex), the default is RelFrameID=ALL.

If the ORD attribute is not specified and the RelFrameID is explicitly set to ALL (not omitted), then ORD is ALL. In all other cases, the default value of ORD is 1.