GetFormString

 

Description

 

Returns the current HTML FORM string for the specified FORM.

 

Arguments

 

Name

Type

I/O

Description

HObject

Long Integer

In

The ObjectHandle for the page of interest (use zero for the current page).

FormIndex

Long Integer

In

The zero-based FORM index. Must be less than the value returned by the GetFormCount method.

SubmitName

String

In

Blank for default (blank) submit or the NAME attribute of a specific Submit button.

 

Return Value

 

String: HTML FORM string for the specified FORM.

 

Remarks

 

The HTML FORM string consists of NAME=VALUE pairs, separated by ampersands ("&").

 

Values in the FORM string are form-encoded, which means that spaces are translated to plus sign characters ("+") and other non-alphanumeric characters are translated to three-character sequences consisting of a percent sign character hexadecimal sequences of the form "%xx".

 

Use the GetFormCount method to get the number of HTML FORMs on a page.

 

This method can be applied to the current visible page or to any other page in cache.

 

The current visible page is used when the hObject argument is zero. Specify an explicit ObjectHandle when referring to a cached page other than the visible page, or to a FRAME page in a FRAMESET.