$Alpha: Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
m (misc cleanup)
Line 1: Line 1:
<p>The $Alpha function verifies whether a string is composed only of characters which are valid in the specified (or default) language. A 1 is returned if the condition is true; otherwise, a 0 is returned (for a false condition). A 0 is returned if there are any spaces or punctuation marks in the string, or if the string is null.</p>
<p>
<b>Syntax</b>
The <var>$Alpha</var> function verifies whether a string is composed only of characters which are valid in the specified (or default) language. A 1 is returned if the condition is true; otherwise, a 0 is returned (for a false condition). A 0 is returned if there are any spaces or punctuation marks in the string, or if the string is null.</p>
 
==Syntax==
<p>The format of the $Alpha function is:</p>
<p>The format of the $Alpha function is:</p>
<p class="code">$Alpha(string <var>[</var>,language<var>]</var>)
<p class="syntax">$Alpha(<span class="term">string</span> [,<span class="term">language</span>]) </p>
</p>
<p>
<p>where:</p>
Where:</p>
<ul>
<ul>
<li>string represents the string to be verified. string must be one of:</li>
<li><var class="term">string</var> represents the string to be verified. string must be one of:
</li>
</ul>
<p>A literal enclosed in quotation marks</p>
<ul>
<ul>
<li>%variable.</li>
<li>A literal enclosed in quotation marks</li>
</li>
 
<li>A field name without quotation marks. In this case, the function call must be embedded in a FOR EACH RECORD loop where the current value of the field is verified.</li>
<li>%variable</li>
</li>
 
</ul>
<li>A field name without quotation marks. In this case, the function call must be embedded in a <var>FOR EACH RECORD</var> loop where the current value of the field is verified.</li>
<p><var>The optional language</var> argument specifies the language to use. The language argument is handled as follows:</p>
</ul></li>
 
<li>The optional <var class="term">language</var> argument specifies the language to use. The language argument is handled as follows:
<ul>
<ul>
<li>You can enter a literal enclosed in quotation marks or a % variable containing a valid language name. If the value you enter is not a supported language, the request is canceled with the following error message. See The LANGUSER parameter in the Rocket <var class="product">Model&nbsp;204</var> Parameter and Command Reference Manual for the valid values.</li>
<li>You can enter a literal enclosed in quotation marks or a %variable containing a valid language name. If the value you enter is not a supported language, the request is canceled with the following error message. See the <var>[[LANGUSER parameter|LANGUSER]]</var> parameter for the valid values.
<p class="code">M204.2340: INVALID LANGUAGE ARGUMENT: 'language' FOR $FUNCTION: ALPHA  
<p class="code">M204.2340: INVALID LANGUAGE ARGUMENT: 'language' FOR $FUNCTION: ALPHA  
</p></li>
</p></li>
<li>When<var> you omit the language</var> argument, <var class="product">Model&nbsp;204</var> performs the validation in U.S. English, even if the value of the LANGUSER parameter is not US, and lowercase characters are not recognized.</li>
 
</li>
<li>If you omit the <var class="term">language</var> argument, <var class="product">Model&nbsp;204</var> performs the validation in U.S. English, even if the value of the <var>LANGUSER</var> parameter is not <code>US</code>, and lowercase characters are not recognized.</li>
<li>An asterisk enclosed in quotation marks ('*') instructs <var class="product">Model&nbsp;204</var> to use the value of the LANGUSER parameter. </li>
 
<li>An asterisk enclosed in quotation marks (<tt>'*'</tt>) instructs <var class="product">Model&nbsp;204</var> to use the value of the <var>LANGUSER</var> parameter.
</li>
</li>
</ul></li>
</ul>
</ul>
<b>Examples</b>
 
<p>The following table has examples of the pattern and language arguments as literals:</p>
==Examples==
<p>
The following table has examples of the pattern and language arguments as literals:</p>
<table>
<table>
<tr class="head">
<tr class="head">
Line 35: Line 40:
<tr>
<tr>
<td>
<td>
<p class="code"><var>$alpha('JOHN','US')</var>
<p class="codeInTable">$alpha('JOHN','US')</p></td>
</p></td>
<td align="right"><p>1</p></td></tr>
<td align="right"><var>1</var></td>
 
</tr>
<tr><td><p class="codeInTable">$alpha('M&Acirc;CON','FRENCHC')</p></td>
<tr>
<td align="right"><p>1</p></td></tr>
<td>
 
<p class="code"><var>$alpha('M�CON','FRENCHC')</var>
<tr><td><p class="codeInTable">$alpha('M&Acirc;CON','US')</p></td>
</p></td>
<td align="right"><p>0</p></td></tr>
<td align="right"><var>1</var></td>
 
</tr>
<tr><td><p class="codeInTable">$alpha('JOHN SMITH','US')</p></td>
<tr>
<td align="right"><p>0</p></td></tr>
<td>
 
<p class="code">$alpha('<var>M�CON','US')</var>
<tr><td><p class="codeInTable">$alpha('&Icirc;LE D'ORL&Eacute;ANS','FRENCHC')</p></td>
</p></td>
<td align="right"><p>0</p></td></tr>
<td align="right">0</td>
 
</tr>
<tr><td><p class="codeInTable">$alpha('12A','US')</p></td>
<tr>
<td align="right"><p>0</p></td></tr>
<td>
 
<p class="code"><var>$alpha('JOHN SMITH','US')</var>
<tr><td><p class="codeInTable">$alpha('12A','FRENCHC')</p></td>
</p></td>
<td align="right"><p>0</p></td></tr>
<td align="right"><var>0</var></td>
</tr>
<tr>
<td>
<p class="code"><var>$alpha('�LE D'ORL�ANS','FRENCHC')</var>
</p></td>
<td align="right"><var>0</var></td>
</tr>
<tr>
<td>
<p class="code"><var>$alpha('12A','US')</var>
</p></td>
<td align="right"><var>0</var></td>
</tr>
<tr>
<td>
<p class="code"><var>$alpha('12A','FRENCHC')</var>
</p></td>
<td align="right"><var>0</var></td>
</tr>
</table>
</table>
<p>The following request sorts and prints the names of agents whose name contains non alphabetic characters. The quoted asterisk in the $Alpha call causes <var class="product">Model&nbsp;204</var> to verify the contents of the field AGENT against whatever language is indicated by the value of the LANGUSER parameter:</p>
<p>
The following request sorts and prints the names of agents whose name contains non alphabetic characters. The quoted asterisk in the <var>$Alpha</var> call causes <var class="product">Model&nbsp;204</var> to verify the contents of the field <code>AGENT</code> against whatever language is indicated by the value of the <var>LANGUSER</var> parameter:</p>
<p class="code">BEGIN
<p class="code">BEGIN
POL.HOLDERS:  FIND ALL RECORDS FOR WHICH
POL.HOLDERS:  FIND ALL RECORDS FOR WHICH
Line 92: Line 78:
END   
END   
</p>
</p>
<p class="note"><b>Note:</b> For upward compatibility reasons, $Alpha and $Alphnum do not recognize lowercase English letters as alphabetic characters unless a non-null language parameter is specified.</p>
<p class="note"><b>Note:</b> For upward compatibility reasons, <var>$Alpha</var> and <var>$Alphnum</var> do not recognize lowercase English letters as alphabetic characters unless a non-null language parameter is specified.</p>
 
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Revision as of 20:47, 9 March 2015

The $Alpha function verifies whether a string is composed only of characters which are valid in the specified (or default) language. A 1 is returned if the condition is true; otherwise, a 0 is returned (for a false condition). A 0 is returned if there are any spaces or punctuation marks in the string, or if the string is null.

Syntax

The format of the $Alpha function is:

$Alpha(string [,language])

Where:

  • string represents the string to be verified. string must be one of:
    • A literal enclosed in quotation marks
    • %variable
    • A field name without quotation marks. In this case, the function call must be embedded in a FOR EACH RECORD loop where the current value of the field is verified.
  • The optional language argument specifies the language to use. The language argument is handled as follows:
    • You can enter a literal enclosed in quotation marks or a %variable containing a valid language name. If the value you enter is not a supported language, the request is canceled with the following error message. See the LANGUSER parameter for the valid values.

      M204.2340: INVALID LANGUAGE ARGUMENT: 'language' FOR $FUNCTION: ALPHA

    • If you omit the language argument, Model 204 performs the validation in U.S. English, even if the value of the LANGUSER parameter is not US, and lowercase characters are not recognized.
    • An asterisk enclosed in quotation marks ('*') instructs Model 204 to use the value of the LANGUSER parameter.

Examples

The following table has examples of the pattern and language arguments as literals:

Function code... Returns...

$alpha('JOHN','US')

1

$alpha('MÂCON','FRENCHC')

1

$alpha('MÂCON','US')

0

$alpha('JOHN SMITH','US')

0

$alpha('ÎLE D'ORLÉANS','FRENCHC')

0

$alpha('12A','US')

0

$alpha('12A','FRENCHC')

0

The following request sorts and prints the names of agents whose name contains non alphabetic characters. The quoted asterisk in the $Alpha call causes Model 204 to verify the contents of the field AGENT against whatever language is indicated by the value of the LANGUSER parameter:

BEGIN POL.HOLDERS: FIND ALL RECORDS FOR WHICH RECTYPE = POLICYHOLDER END FIND FOR EACH RECORD IN POL.HOLDERS IF NOT $alpha (AGENT, '*') THEN PLACE RECORD ON LIST BADNAME END IF END FOR ORDERED.LIST: SORT RECORDS ON LIST BADNAME BY AGENT FOR EACH RECORD IN ORDERED.LIST PRINT AGENT END FOR END

Note: For upward compatibility reasons, $Alpha and $Alphnum do not recognize lowercase English letters as alphabetic characters unless a non-null language parameter is specified.