$Web IsIndex Name: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Web_IsIndex_Name}} | {{DISPLAYTITLE:$Web_IsIndex_Name}} | ||
<span class="pageSubtitle"><section begin="desc" />Name of isindex field<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Name of isindex field<section end="desc" /></span> | ||
$Web_IsIndex_Name retrieves the name of an isindex field in a URL. | $Web_IsIndex_Name retrieves the name of an isindex field in a URL. | ||
Since isindex fields are more commonly called "URL parameters," you may want to use this $function's synonym, $Web_URL_Parm_Name (see [[$Web_URL_Parm_Name]]). | Since isindex fields are more commonly called "URL parameters," you may want to use this $function's synonym, $Web_URL_Parm_Name (see [[$Web_URL_Parm_Name]]). | ||
$Web_IsIndex_Name takes a single argument and returns a string or null if the number references a non-existing field. | $Web_IsIndex_Name takes a single argument and returns a string or null if the number references a non-existing field. | ||
| Line 16: | Line 10: | ||
The only parameter is the number of the isindex field for which the name is being requested. This parameter must be specified. | The only parameter is the number of the isindex field for which the name is being requested. This parameter must be specified. | ||
$Web_IsIndex_Name is useful when writing generic server applications, when the server does not know what field name exists at a particular location in an isindex request. | ==Syntax== | ||
<p class="code"> | <p class="syntax"><section begin="syntax" /> %RC = $Web_IsIndex_Name( field_number ) | ||
<section end="syntax" /></p> | |||
==Usage notes== | |||
<ul> | |||
<li>$Web_IsIndex_Name is useful when writing generic server applications, when the server does not know what field name exists at a particular location in an isindex request. | |||
<p class="code">* Get the number of isindex fields. | |||
%X = $Web_Num_IsIndex | |||
* Load the field names into an array. | |||
FOR %Y FROM 1 TO %X | |||
%FIELD(%Y) = $Web_IsIndex_Name(%Y) | |||
END FOR | |||
</p> | </p> | ||
<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> | |||
==See also== | |||
See also | |||
<ul> | <ul> | ||
<li><var>[[$Web_IsIndex_Parm_Len]]</var> | <li><var>[[$Web_IsIndex_Parm_Len]]</var> | ||
<li><var>[[$Web_IsIndex_Parm]]</var> | <li><var>[[$Web_IsIndex_Parm]]</var> | ||
<li><var>[[$Web_Num_IsIndex]]</var> | <li><var>[[$Web_Num_IsIndex]]</var> | ||
</ul> | </ul> | ||
[[Category:Janus Web Server $functions|$Web_IsIndex_Name]] | [[Category:Janus Web Server $functions|$Web_IsIndex_Name]] | ||
Revision as of 21:48, 12 June 2012
<section begin="desc" />Name of isindex field<section end="desc" />
$Web_IsIndex_Name retrieves the name of an isindex field in a URL.
Since isindex fields are more commonly called "URL parameters," you may want to use this $function's synonym, $Web_URL_Parm_Name (see $Web_URL_Parm_Name).
$Web_IsIndex_Name takes a single argument and returns a string or null if the number references a non-existing field.
The only parameter is the number of the isindex field for which the name is being requested. This parameter must be specified.
Syntax
<section begin="syntax" /> %RC = $Web_IsIndex_Name( field_number ) <section end="syntax" />
Usage notes
- $Web_IsIndex_Name is useful when writing generic server applications, when the server does not know what field name exists at a particular location in an isindex request.
* Get the number of isindex fields. %X = $Web_Num_IsIndex * Load the field names into an array. FOR %Y FROM 1 TO %X %FIELD(%Y) = $Web_IsIndex_Name(%Y) END FOR
- For a discussion of isindex requests and data see "URL parameters or isindex data".