$Web IsIndex Parm Lstr: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 4: | Line 4: | ||
$Web_IsIndex_Parm_Lstr retrieves the value of a URL parameter as a [[Longstrings|longstring]]. | $Web_IsIndex_Parm_Lstr retrieves the value of a URL parameter as a [[Longstrings|longstring]]. | ||
Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, [[$Web_URL_Parm_Lstr]]. | Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, <var>[[$Web_URL_Parm_Lstr]]</var>. | ||
$Web_IsIndex_Parm_Lstr takes two arguments and returns a longstring (or null for any error condition). | $Web_IsIndex_Parm_Lstr takes two arguments and returns a longstring (or null for any error condition). | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> % | <p class="syntax"><section begin="syntax" />%string = $Web_IsIndex_Parm_Lstr( name, occurrence ) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
| Line 15: | Line 15: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>The name of the URL parameter, returned by <var>$Web_IsIndex_Name</var>. This is a required argument if occurrence is not specified; otherwise it is optional.</td></tr> | <td>The name of the URL parameter, returned by <var>[[$Web_IsIndex_Name]]</var>. This is a required argument if occurrence is not specified; otherwise it is optional.</td></tr> | ||
<tr><th>occurrence</th> | <tr><th>occurrence</th> | ||
<td>The occurrence number of a URL parameter, or the occurrence number of the URL parameter matching ''name'', if ''name'' is specified. This is an optional argument if | <td>The occurrence number of a URL parameter, or the occurrence number of the URL parameter matching ''name'', if ''name'' is specified. This is an optional argument if <var class="term">name</var> is specified; otherwise it is required. | ||
</td></tr></table> | </td></tr></table> | ||
| Line 23: | Line 23: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>$Web_IsIndex_Parm_Lstr works much like $ | <li>$Web_IsIndex_Parm_Lstr works much like $Web_IsIndex_Parm, except for the following: | ||
<ul> | <ul> | ||
| Line 44: | Line 44: | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li><var>[[$Web_IsIndex_Parm]]</var> | <li><var>[[$Web_IsIndex_Parm]]</var> | ||
<li><var>[[$Web_IsIndex_Name]]</var> | <li><var>[[$Web_IsIndex_Name]]</var> | ||
Revision as of 15:35, 15 June 2012
<section begin="desc" />Value of URL parameter to longstring<section end="desc" />
$Web_IsIndex_Parm_Lstr retrieves the value of a URL parameter as a longstring.
Since isindex fields are more commonly called "URL parameters," you may want to use the synonym for this $function, $Web_URL_Parm_Lstr.
$Web_IsIndex_Parm_Lstr takes two arguments and returns a longstring (or null for any error condition).
Syntax
<section begin="syntax" />%string = $Web_IsIndex_Parm_Lstr( name, occurrence ) <section end="syntax" />
Syntax terms
| name | The name of the URL parameter, returned by $Web_IsIndex_Name. This is a required argument if occurrence is not specified; otherwise it is optional. |
|---|---|
| occurrence | The occurrence number of a URL parameter, or the occurrence number of the URL parameter matching name, if name is specified. This is an optional argument if name is specified; otherwise it is required. |
Usage notes
- $Web_IsIndex_Parm_Lstr works much like $Web_IsIndex_Parm, except for the following:
- It can return more than 255 bytes of data into a longstring.
- It causes request cancellation if the result would be truncated, either on assignment to the target STRING %variable, or as input to a STRING $function argument or subroutine parameter.
- It does not have position and length arguments (arguments 3 and 4).
Examples
If you have a URL that looks like:
http://myhost.edu/whatever?war=peace&love=hate
The following will retrieve the values of the War andLove fields into longstrings called %war and%love.
%war = $web_form_parm_lstr('WAR') %love = $web_form_parm_lstr('LOVE')