$Web IsIndex Parm Num Line: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 4: Line 4:




$Web_IsIndex_Parm_Num_Line retrieves the number of lines in an isindex field. It is especially useful for ''textarea'' input fields.  
<var>$Web_IsIndex_Parm_Num_Line</var> retrieves the number of lines in an isindex field. It is especially useful for ''textarea'' input fields.  


$Web_IsIndex_Num_Line is a short synonym for $Web_IsIndex_Parm_Num_Line.  
<var>$Web_IsIndex_Num_Line</var> is a short synonym for <var>[[$Web_IsIndex_Parm_Num_Line]]</var>.
 
Since isindex fields are more commonly called "URL parameters," you can use another synonym for this $function, <var>[[$Web_URL_Parm_Num_Line]]</var>.
 
<var>$Web_IsIndex_Parm_Num_Line</var> takes two arguments and returns either the number of lines in the isindex field or a 0 indicating either that there were no lines in the isindex field or that some other error has occurred. Possible errors would be the isindex field not being found or the function being invoked on a non-web server thread.


Since isindex fields are more commonly called "URL parameters," you can use another synonym for this $function, [[$Web_URL_Parm_Num_Line]].
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %string = $Web_isIndex_Parm_Num_Line( fieldname, -
<p class="syntax"><section begin="syntax" /> %string = $Web_isIndex_Parm_Num_Line( fieldname, occurrence )
occurrence )
<section end="syntax" /></p>
<section end="syntax" /></p>


 
===Syntax terms===
$Web_IsIndex_Parm_Num_Line takes two arguments and returns either the number of lines in the isindex field or a 0 indicating either that there were no lines in the isindex field or that some other error has occurred. Possible errors would be the isindex field not being found or the function being invoked on a non-web server thread.
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>fieldname</th>
<tr><th>fieldname</th>
Line 23: Line 24:
</td></tr></table>
</td></tr></table>


==Usage notes==
<ul>
<li>A line is considered to be a block of text that is terminated by either an ASCII carriage return (X'0D') or a carriage return followed by a line feed (X'0A'). This is what is ordinarily sent by a browser to mark the end of each line of a textarea input field.
<li>For a discussion of isindex requests and data, see [[Janus Web Server application coding considerations#URL parameters or isindex data|"URL parameters or isindex data"]].
</ul>


 
==Examples==
A line is considered to be a block of text that is terminated by either an ASCII carriage return (X'0D') or a carriage return followed by a line feed (X'0A'). This is what is ordinarily sent by a browser to mark the end of each line of a textarea input field.
 
This example checks if the number of lines returned in a textarea exceeds the size of the array meant to hold the input from the textarea.
This example checks if the number of lines returned in a textarea exceeds the size of the array meant to hold the input from the textarea.
<p class="code">  
<p class="code">%LINES = $Web_IsIndex_Parm_Num_Line('COMMENTS')
%LINES = $Web_IsIndex_Parm_Num_Line('COMMENTS')
IF %LINES GT %MAXLINES THEN
IF %LINES GT %MAXLINES THEN
AUDIT 'Maximum lines exceeded for ' WITH -
AUDIT 'Maximum lines exceeded for ' WITH -
$Web_Hdr_Parm('URL') WITH ' - input will be truncated'
$Web_Hdr_Parm('URL') WITH -
%LINES = %MAXLINES
' - input will be truncated'
END IF
%LINES = %MAXLINES
END IF
</p>
</p>


Line 48: Line 50:
<li><var>[[$Web_IsIndex_Parm]]</var>
<li><var>[[$Web_IsIndex_Parm]]</var>
</ul>
</ul>
For a discussion of isindex requests and data, see .
 


[[Category:Janus Web Server $functions|$Web_IsIndex_Parm_Num_Line]]
[[Category:Janus Web Server $functions|$Web_IsIndex_Parm_Num_Line]]

Revision as of 14:15, 13 June 2012

<section begin="desc" />Number of isindex field lines<section end="desc" />


$Web_IsIndex_Parm_Num_Line retrieves the number of lines in an isindex field. It is especially useful for textarea input fields.

$Web_IsIndex_Num_Line is a short synonym for $Web_IsIndex_Parm_Num_Line.

Since isindex fields are more commonly called "URL parameters," you can use another synonym for this $function, $Web_URL_Parm_Num_Line.

$Web_IsIndex_Parm_Num_Line takes two arguments and returns either the number of lines in the isindex field or a 0 indicating either that there were no lines in the isindex field or that some other error has occurred. Possible errors would be the isindex field not being found or the function being invoked on a non-web server thread.

Syntax

<section begin="syntax" /> %string = $Web_isIndex_Parm_Num_Line( fieldname, occurrence ) <section end="syntax" />

Syntax terms

fieldname The name of the isindex field, returned by $Web_IsIndex_Name. Required argument if occurrence not specified, otherwise optional.
occurrence The occurrence number of a isindex field, or the occurrence number of the isindex field matching 'fieldname', if fieldname is specified. Optional argument if fieldname is specified, otherwise it is required.

Usage notes

  • A line is considered to be a block of text that is terminated by either an ASCII carriage return (X'0D') or a carriage return followed by a line feed (X'0A'). This is what is ordinarily sent by a browser to mark the end of each line of a textarea input field.
  • For a discussion of isindex requests and data, see "URL parameters or isindex data".

Examples

This example checks if the number of lines returned in a textarea exceeds the size of the array meant to hold the input from the textarea.

%LINES = $Web_IsIndex_Parm_Num_Line('COMMENTS') IF %LINES GT %MAXLINES THEN AUDIT 'Maximum lines exceeded for ' WITH - $Web_Hdr_Parm('URL') WITH ' - input will be truncated' %LINES = %MAXLINES END IF


See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Web_IsIndex_Parm_Num_Line&oldid=36453"