$Web IsIndex Name: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(5 intermediate revisions by 3 users not shown)
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">Name of isindex field</span>


<var>$Web_IsIndex_Name</var> retrieves the name of an isindex field in a URL.  
<var>$Web_IsIndex_Name</var> retrieves the name of an isindex field in a URL.  
Line 11: Line 11:


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" />%rc = $Web_IsIndex_Name( field_number )
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_IsIndex_Name</span>(<span class="term"> field_number</span> )
<section end="syntax" /></p>
</p>


==Usage notes==
==Usage notes==
Line 24: Line 24:
   
   
FOR %Y FROM 1 TO %X
FOR %Y FROM 1 TO %X
%FIELD(%Y) = $Web_IsIndex_Name(%Y)
  %FIELD(%Y) = $Web_IsIndex_Name(%Y)
END FOR
END FOR
</p>
</p>

Latest revision as of 22:21, 5 June 2013

Name of isindex field

$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.

$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

%rc = $Web_IsIndex_Name( field_number )

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".

See also