$Web IsIndex Parm Len: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Web_IsIndex_Parm_Len}} | {{DISPLAYTITLE:$Web_IsIndex_Parm_Len}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Length of isindex field</span> | ||
$Web_IsIndex_Len retrieves the length of an isindex field in a URL. <var>$Web_IsIndex_Parm_Len</var> is a somewhat more syntactically correct synonym for $Web_IsIndex_Len. | <var>$Web_IsIndex_Len</var> retrieves the length of an isindex field in a URL. <var>$Web_IsIndex_Parm_Len</var> is a somewhat more syntactically correct synonym for <var>$Web_IsIndex_Len</var>. | ||
Since isindex fields are more commonly called "URL parameters," you can use another synonym for this $function, <var>[[$Web_URL_Parm_Len]]</var>. | Since isindex fields are more commonly called "URL parameters," you can use another synonym for this $function, <var>[[$Web_URL_Parm_Len]]</var>. | ||
$Web_IsIndex_Len takes two arguments and returns a number, or zero if the field does not exist. | <var>$Web_IsIndex_Len</var> takes two arguments and returns a number, or zero if the field does not exist. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%rc</span> = $Web_IsIndex_[Parm_]Len( <span class="term">fieldname, occurrence</span> ) | ||
< | </p> | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>fieldname</th> | <tr><th>fieldname</th> | ||
<td>The name of the isindex field, returned by <var>$Web_IsIndex_Name</var>. Required argument if occurrence not specified, otherwise optional.</td></tr> | <td>The name of the isindex field, returned by <var>[[$Web_IsIndex_Name]]</var>. Required argument if occurrence not specified, otherwise optional.</td></tr> | ||
<tr><th>occurrence</th> | <tr><th>occurrence</th> | ||
<td>The occurrence number of an 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. | <td>The occurrence number of an 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. | ||
</td></tr></table> | </td></tr></table> | ||
==See also== | ==See also== | ||
Latest revision as of 22:23, 5 June 2013
Length of isindex field
$Web_IsIndex_Len retrieves the length of an isindex field in a URL. $Web_IsIndex_Parm_Len is a somewhat more syntactically correct synonym for $Web_IsIndex_Len.
Since isindex fields are more commonly called "URL parameters," you can use another synonym for this $function, $Web_URL_Parm_Len.
$Web_IsIndex_Len takes two arguments and returns a number, or zero if the field does not exist.
Syntax
%rc = $Web_IsIndex_[Parm_]Len( fieldname, occurrence )
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 an 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. |