Form fields: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
mNo edit summary
imported>StDoodle
m betterer more info
Line 29: Line 29:


see_also={{SeeAlso|form_field|write|writeln}}|
see_also={{SeeAlso|form_field|write|writeln}}|
more_info=See [http://kolmafia.us/showthread.php?3842-Form-of...HTML!&highlight=form+html this thread] for details.|
more_info=See [[Relay_Override_Scripting#User_Interface_Script|User Interface Scripts]] for more information.|
}}
}}

Revision as of 14:00, 3 May 2010

Function Syntax

string [string] form_fields()

  • Similiar to form_field(), but returns a map with all the name/value pairs from the relay request being handled. Unlike the form_field() function, this allows iterating over all the fields, and can distinguish a field with a blank value from a nonexistent field. (The exception to this being checkboxes, which return no information when unchecked.)

Used to read form information in User Interface Scripts.

Code Sample

Read the form fields in a UI script for use later.

string [string] fields;
fields = form_fields();
boolean success = count(fields) > 0;

See Also

form_field() | write() | writeln()

More Information

See User Interface Scripts for more information.