$Web IsIndex Parm: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Value of isindex field<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Value of isindex field<section end="desc" /></span> | ||
$Web_IsIndex_Parm retrieves the value of an isindex field in a URL. | |||
Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, <var>[[$Web_URL_Parm]]</var>. | |||
$Web_IsIndex_Parm | $Web_IsIndex_Parm takes four arguments and returns a string, or null for any error condition. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> % | <p class="syntax"><section begin="syntax" /> %string = $Web_IsIndex_Parm( fieldname, occurrence, start, length ) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
===Syntax terms=== | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>fieldname</th> | <tr><th>fieldname</th> | ||
| Line 25: | Line 24: | ||
</td></tr></table> | </td></tr></table> | ||
==Examples== | |||
This example places the value of each isindex field in a URL into a User Language %variable of the same name. | This example places the value of each isindex field in a URL into a User Language %variable of the same name. | ||
<p class="code"> | <p class="code">*Stash the form values in matching fields. | ||
%CUST_NAME = $Web_IsIndex_Parm('CUST_NAME' ) | |||
%CUST_NUM = $Web_IsIndex_Parm('CUST_NUM' ) | |||
%ORDER_NUM = $Web_IsIndex_Parm('ORDER_NUM' ) | |||
%ORDER_DATE = $Web_IsIndex_Parm('ORDER_DATE' ) | |||
%ORDER_ITEM = $Web_IsIndex_Parm('ORDER_ITEM') | |||
%ORDER_ITEM2 = $Web_IsIndex_Parm('ORDER_ITEM', 2) | |||
</p> | </p> | ||
Revision as of 22:16, 12 June 2012
<section begin="desc" />Value of isindex field<section end="desc" />
$Web_IsIndex_Parm retrieves the value of an isindex field in a URL.
Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, $Web_URL_Parm.
$Web_IsIndex_Parm takes four arguments and returns a string, or null for any error condition.
Syntax
<section begin="syntax" /> %string = $Web_IsIndex_Parm( fieldname, occurrence, start, length ) <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 an isindex field, or the occurrence number of the isindex field matching fieldname, if fieldname is specified. This is an optional argument if fieldname is specified; otherwise it is required. |
| start | Starting position within the field. This is an optional argument which defaults to 1. |
| length | Length to return. This is an optional argument, provided in case an isindex field exceeds 255 bytes. The length of an isindex field can be determined with $Web_IsIndex_Len. The default is the length of the isindex field. |
Examples
This example places the value of each isindex field in a URL into a User Language %variable of the same name.
*Stash the form values in matching fields. %CUST_NAME = $Web_IsIndex_Parm('CUST_NAME' ) %CUST_NUM = $Web_IsIndex_Parm('CUST_NUM' ) %ORDER_NUM = $Web_IsIndex_Parm('ORDER_NUM' ) %ORDER_DATE = $Web_IsIndex_Parm('ORDER_DATE' ) %ORDER_ITEM = $Web_IsIndex_Parm('ORDER_ITEM') %ORDER_ITEM2 = $Web_IsIndex_Parm('ORDER_ITEM', 2)