$Web Form Action: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Web_Form_Action}}
{{DISPLAYTITLE:$Web_Form_Action}}
<span class="pageSubtitle"><section begin="desc" />Return action URL<section end="desc" /></span>
<span class="pageSubtitle">Return action URL</span>


<var>$Web_Form_Action</var> returns the relative URL of the current request.
<var>$Web_Form_Action</var> returns the relative URL of the current request.
Line 7: Line 7:


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" />%rc = $Web_Form_Action([pos], [len])
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Form_Action</span>([<span class="term">pos</span>], [<span class="term">len</span>])
<section end="syntax" /></p>
</p>


===Syntax terms===
===Syntax terms===
Line 14: Line 14:
<tr><th>%rc</th>
<tr><th>%rc</th>
<td>A numeric variable to contain the return code. </td></tr>
<td>A numeric variable to contain the return code. </td></tr>
<tr><th>pos</th>
<tr><th>pos</th>
<td>This numeric value is the starting position in the URL for the current request to be returned. This is an optional parameter, and it defaults to one, meaning that the current URL is returned starting at the first character. </td></tr>
<td>This numeric value is the starting position in the URL for the current request to be returned. This is an optional parameter, and it defaults to one, meaning that the current URL is returned starting at the first character. </td></tr>
<tr><th>len</th>
<tr><th>len</th>
<td>This numeric value is the maximum number of characters to be returned. This is an optional parameter and it defaults to 255. </td></tr>
<td>This numeric value is the maximum number of characters to be returned. This is an optional parameter and it defaults to 255. </td></tr>
Line 38: Line 40:
</p>
</p>
<p>
<p>
If there is a possibility that the current relative URL along with the ISINDEX data is longer than 255 bytes, <var>$Web_Form_Action</var> should be used in a loop in conjunction with <var>$Web_Form_Action_Len</var> as demonstrated here: </p>
If there is a possibility that the current relative URL along with the ISINDEX data is longer than 255 bytes, use <var>$Web_Form_Action</var> in a loop in conjunction with <var>[[$Web_Form_Action_Len]]</var>, as demonstrated here: </p>
<p class="code">PRINT '<form method="POST" action="' ...
<p class="code">PRINT '<form method="POST" action="' ...
FOR %I FROM 1 TO $Web_Form_Action_Len BY 255
FOR %I FROM 1 TO $Web_Form_Action_Len BY 255
Line 46: Line 48:
</p>
</p>
</ul>
</ul>
<p class="note"><b>Note:</b> The maximum Janus Web Server URL length is 1,024 bytes. </p>


==See also==
==See also==

Latest revision as of 21:59, 11 September 2019

Return action URL

$Web_Form_Action returns the relative URL of the current request.

$Web_Form_Action takes two arguments and returns a string.

Syntax

%rc = $Web_Form_Action([pos], [len])

Syntax terms

%rc A numeric variable to contain the return code.
pos This numeric value is the starting position in the URL for the current request to be returned. This is an optional parameter, and it defaults to one, meaning that the current URL is returned starting at the first character.
len This numeric value is the maximum number of characters to be returned. This is an optional parameter and it defaults to 255.

Usage notes

  • $Web_Form_Action, as the name might suggest, is most useful in generating the URL for the "action" attribute of the <form> tag in HTML. This is especially useful if the current URL includes ISINDEX data that might be relatively difficult to reconstruct otherwise. The following demonstrates how one might use the $Web_Form_Action function in a form generated with the HTML statement.

    HTML <form method="POST" action="{$Web_Form_Action}">
    Name: <input size=20 type="text" name="name" value="{%NAME}">
    Rank: <input size=12 type="text" name="rank" value="{%RANK}">
    Serial number: <input size=12 type="text" name="serno" value="{%SERNO}">
    <input type="submit" value="Update"> </form> END HTML

    If there is a possibility that the current relative URL along with the ISINDEX data is longer than 255 bytes, use $Web_Form_Action in a loop in conjunction with $Web_Form_Action_Len, as demonstrated here:

    PRINT '<form method="POST" action="' ... FOR %I FROM 1 TO $Web_Form_Action_Len BY 255 PRINT $Web_Form_Action(%I) ... END FOR PRINT '">'

Note: The maximum Janus Web Server URL length is 1,024 bytes.

See also