$AlphNum - Revision history

JAL: add italics

2018-01-08T20:07:08Z

add italics

← Older revision		Revision as of 20:07, 8 January 2018
Line 1:		Line 1:
	<p>		<p>
	The <var>$AlphNum</var> function verifies whether a string is composed only of characters that are valid in the specified (or default) language, and digits 0 through 9.		The <var>$AlphNum</var> function verifies whether a string is composed only of characters that are valid in the specified (or default) language, and digits 0 through 9. </p>
	~~<ul>~~
	~~<li>1 is returned for a true condition.</li>~~
	~~<li>0 is returned for a false condition if there are any spaces or punctuation marks in the string, or if the string is null.</li>~~
	~~</ul>~~</p>

	==Syntax==		==Syntax==
	<p class="syntax">$AlphNum(<span class="term">string</span>[,<span class="term">language</span>])		<p class="syntax"><span class="term">%result</span> = $AlphNum(<span class="term">string</span>[,<span class="term">language</span>])
	</p>		</p>
	<p>
	~~Where:~~</p>		<table>
			<tr><th>%result</th>
			<td>A numeric variable that contains:
	<ul>		<ul>
	<li>~~The~~ <~~var class="term"~~>~~string~~<~~/var~~> ~~argument represents the characters to verify~~, ~~which must be~~ one of ~~the following~~:		<li>1, for a true condition.</li>
			<li>0, for a false condition if one of these occurs:
	<ul>		<ul>
	<li>A string ~~of characters enclosed in quotation marks.~~</li>		<li><var class="term">string</var> contains spaces or punctuation marks</li>
			<li><var class="term">string</var> is null</li>
	~~<li>A [[Using_variables_and_values_in_computation\|%variable]].~~</li>

	<li>~~A field name that is not enclosed in quotation marks. In this case, the function call must be embedded in a~~ <var>~~[[Record_loops#FOR_EACH_RECORD_statement\|FOR EACH RECORD]]~~</var> ~~loop where the current value of the field~~ is ~~verified.~~</li>
	</ul></li>		</ul></li>
			</ul></td></tr>

	<li>The ~~optional~~ <var class="term">~~language~~</var> ~~argument specifies~~ the ~~language to use. The language argument is handled as follows~~:		<tr><th>string</th>
			<td>The string to be verified. <var class="term">string</var> must be one of the following:
	<ul>		<ul>
	<li>~~If the~~ <~~var class="term"~~>~~language~~</~~var~~> ~~argument~~ is ~~omitted~~, <var ~~class="product"~~>~~Model 204~~</var> ~~performs the validation in U.S. English (even if~~ the value of the <~~var~~>~~LANGUSER~~</~~var~~> ~~parameter is not US) and lowercase characters are not recognized.~~</li>		<li>A literal enclosed in quotation marks</li>
			<li>A [[Using_variables_and_values_in_computation\|%variable]]</li>
			<li>A field name that is not enclosed in quotation marks. In this case, the function call must be embedded in a <var>[[Record loops#FOR EACH RECORD statement\|FOR EACH RECORD]]</var> loop where the current value of the field is verified.</li>
			</ul></td></tr>

	<li>~~An asterisk enclosed in quotation marks (~~<tt>~~'*'~~</tt>~~) instructs~~ <var class="~~product~~">~~Model 204~~</var> ~~to use~~ the value of the <var>LANGUSER</var> parameter.		<tr><th>language</th>
			<td>An optional string that specifies the language to use. <var class="term">language</var> is handled as follows:
			<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 an error message. See the <var>[[LANGUSER parameter\|LANGUSER]]</var> parameter for the valid values.
	</li>		</li>

	<li>~~You can enter~~ the ~~name of a valid~~ language ~~enclosed~~ in ~~quotation marks or a %variable containing a valid language~~. If the value ~~you enter~~ is not ~~supported~~, the ~~request is canceled with an error message. See~~ the <var>[[LANGUSER ~~parameter\|LANGUSER]]~~</var> parameter ~~for the valid values~~.</li>		<li>If you omit the <var class="term">language</var> argument, <var class="product">Model 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>
	</ul>
	</li>		<li>An asterisk enclosed in quotation marks (<tt>'*'</tt>) instructs <var class="product">Model 204</var> to use the value of the <var>LANGUSER</var> parameter. </li>
	</ul>		</ul></td></tr>
			</table>

	==Examples==		==Examples==

DCameron: /* Examples */

2018-01-08T11:42:50Z

Examples

← Older revision		Revision as of 11:42, 8 January 2018
Line 110:		Line 110:
	</p>		</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>		<p class="note"><b>Note:</b> For upward compatibility reasons, <var>[[$Alpha\|$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]]

DCameron: /* Syntax */

2018-01-08T11:36:18Z

Syntax

← Older revision		Revision as of 11:36, 8 January 2018
Line 18:		Line 18:
	<li>A [[Using_variables_and_values_in_computation\|%variable]].</li>		<li>A [[Using_variables_and_values_in_computation\|%variable]].</li>

	<li>A field name that is not enclosed in 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>		<li>A field name that is not enclosed in quotation marks. In this case, the function call must be embedded in a <var>[[Record_loops#FOR_EACH_RECORD_statement\|FOR EACH RECORD]]</var> loop where the current value of the field is verified.</li>
	</ul></li>		</ul></li>

DCameron: /* Syntax */

2018-01-08T11:35:03Z

Syntax

← Older revision		Revision as of 11:35, 8 January 2018
Line 16:		Line 16:
	<li>A string of characters enclosed in quotation marks.</li>		<li>A string of characters enclosed in quotation marks.</li>

	<li>A %variable.</li>		<li>A [[Using_variables_and_values_in_computation\|%variable]].</li>

	<li>A field name that is not enclosed in 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>		<li>A field name that is not enclosed in 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>

ELowell at 22:22, 3 March 2016

2016-03-03T22:22:39Z

← Older revision		Revision as of 22:22, 3 March 2016
Line 1:		Line 1:
	<p>		<p>
	The <var>$AlphNum</var> function verifies whether a string is composed only of characters ~~which~~ are valid in the specified (or default) language, and digits 0 through 9. 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>		The <var>$AlphNum</var> function verifies whether a string is composed only of characters that are valid in the specified (or default) language, and digits 0 through 9.
			<ul>
			<li>1 is returned for a true condition.</li>
			<li>0 is returned for a false condition if there are any spaces or punctuation marks in the string, or if the string is null.</li>
			</ul></p>

	==Syntax==		==Syntax==
Line 16:		Line 20:
	<li>A field name that is not enclosed in 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>		<li>A field name that is not enclosed in 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>
	</ul></li>		</ul></li>
	~~</ul>~~

	<li>The optional <var class="term">language</var> argument specifies the language to use. The language argument is handled as follows:		<li>The optional <var class="term">language</var> argument specifies the language to use. The language argument is handled as follows:
	<ul>		<ul>
	<li>If the <var class="term">language</var> argument is omitted, <var class="product">Model 204</var> performs the validation in U.S. English, even if the value of the <var>LANGUSER</var> parameter is not US, and lowercase characters are not recognized.</li>		<li>If the <var class="term">language</var> argument is omitted, <var class="product">Model 204</var> performs the validation in U.S. English (even if the value of the <var>LANGUSER</var> parameter is not US) and lowercase characters are not recognized.</li>

	<li>An asterisk enclosed in quotation marks (<tt>'*'</tt>) instructs <var class="product">Model 204</var> to use the value of the <var>LANGUSER</var> parameter.		<li>An asterisk enclosed in quotation marks (<tt>'*'</tt>) instructs <var class="product">Model 204</var> to use the value of the <var>LANGUSER</var> parameter.
Line 26:		Line 29:

	<li>You can enter the name of a valid language enclosed in quotation marks or a %variable containing a valid language. If the value you enter is not supported, the request is canceled with an error message. See the <var>[[LANGUSER parameter\|LANGUSER]]</var> parameter for the valid values.</li>		<li>You can enter the name of a valid language enclosed in quotation marks or a %variable containing a valid language. If the value you enter is not supported, the request is canceled with an error message. See the <var>[[LANGUSER parameter\|LANGUSER]]</var> parameter for the valid values.</li>
			</ul>
			</li>
	</ul>		</ul>

	==Examples==		==Examples==
	<p>		<p>
	The following example illustrates the string and language arguments as literals enclosed in quotation marks:</p>		The following example illustrates the <var class="term">string</var> and <var class="term">language</var> arguments as literals enclosed in quotation marks:</p>
	<table>		<table>
	<tr class="head">		<tr class="head">

JAL: misc cleanup

2015-03-09T20:28:14Z

misc cleanup

Show changes

Tbullock: Fix the French letters

2014-09-12T17:12:34Z

Fix the French letters

← Older revision		Revision as of 17:12, 12 September 2014
Line 37:		Line 37:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$alphnum ('~~M�CON~~','FRENCHC')</var>		<p class="code"><var>$alphnum ('MÂCON','FRENCHC')</var>
	</p></td>		</p></td>
	<td align="right"><var>1</var></td>		<td align="right"><var>1</var></td>
Line 43:		Line 43:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$alphnum ('~~M�CON~~','US')</var>		<p class="code"><var>$alphnum ('MÂCON','US')</var>
	</p></td>		</p></td>
	<td align="right">0</td>		<td align="right">0</td>
Line 55:		Line 55:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$alphnum ('~~�LE~~ D'~~ORL�ANS~~','FRENCHC')</var>		<p class="code"><var>$alphnum ('ÎLE D'ORLÉANS','FRENCHC')</var>
	</p></td>		</p></td>
	<td align="right"><var>0</var></td>		<td align="right"><var>0</var></td>

Mlarocca at 13:26, 8 July 2014

2014-07-08T13:26:24Z

← Older revision		Revision as of 13:26, 8 July 2014
Line 1:		Line 1:
	<p>The $~~Alphnum~~ function verifies whether a string is composed only of characters which are valid in the specified (or default) language, and digits 0 through 9. 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>The $AlphNum function verifies whether a string is composed only of characters which are valid in the specified (or default) language, and digits 0 through 9. 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>
	<b>Syntax</b>		<b>Syntax</b>
	<p class="code">$~~Alphnum~~(<var class="term">string</var>[,<var class="term">language</var>])		<p class="code">$AlphNum(<var class="term">string</var>[,<var class="term">language</var>])
	</p>		</p>
	<p>where:</p>		<p>where:</p>
Line 72:		Line 72:
	</tr>		</tr>
	</table>		</table>
	<p>In the following example, the request sorts by name and processes records whose designated field value does not meet the $~~Alphnum~~ criteria. The second argument in the $~~Alphnum~~ call instructs <var class="product">Model 204</var> to use French Canadian to perform the validation:</p>		<p>In the following example, the request sorts by name and processes records whose designated field value does not meet the $AlphNum criteria. The second argument in the $AlphNum call instructs <var class="product">Model 204</var> to use French Canadian to perform the validation:</p>
	<p class="code">BEGIN		<p class="code">BEGIN
	%SEARCH = $READ('ENTER FIELD NAME')		%SEARCH = $READ('ENTER FIELD NAME')
Line 91:		Line 91:
	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, $Alpha and $AlphNum do not recognize lowercase English letters as alphabetic characters unless a non-null language parameter is specified.</p>
	[[Category:SOUL $functions]]		[[Category:SOUL $functions]]

Mlarocca: Mlarocca moved page $Alphnum to $AlphNum: Change N to upper case

2014-07-08T13:25:07Z

Mlarocca moved page $Alphnum to $AlphNum: Change N to upper case

← Older revision	Revision as of 13:25, 8 July 2014
(No difference)

Mlarocca at 12:15, 7 July 2014

2014-07-07T12:15:18Z

← Older revision		Revision as of 12:15, 7 July 2014
Line 1:		Line 1:
	<p>The $~~ALPHNUM~~ function verifies whether a string is composed only of characters which are valid in the specified (or default) language, and digits 0 through 9. 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>The $Alphnum function verifies whether a string is composed only of characters which are valid in the specified (or default) language, and digits 0 through 9. 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>
	<b>Syntax</b>		<b>Syntax</b>
	<p class="code">$~~ALPHNUM~~(<var class="term">string</var>[,<var class="term">language</var>])		<p class="code">$Alphnum(<var class="term">string</var>[,<var class="term">language</var>])
	</p>		</p>
	<p>where:</p>		<p>where:</p>
Line 31:		Line 31:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$~~ALPHNUM~~ ('JOHN','US')</var>		<p class="code"><var>$alphnum ('JOHN','US')</var>
	</p></td>		</p></td>
	<td align="right"><var>1</var></td>		<td align="right"><var>1</var></td>
Line 37:		Line 37:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$~~ALPHNUM~~ ('M�CON','FRENCHC')</var>		<p class="code"><var>$alphnum ('M�CON','FRENCHC')</var>
	</p></td>		</p></td>
	<td align="right"><var>1</var></td>		<td align="right"><var>1</var></td>
Line 43:		Line 43:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$~~ALPHNUM~~ ('M�CON','US')</var>		<p class="code"><var>$alphnum ('M�CON','US')</var>
	</p></td>		</p></td>
	<td align="right">0</td>		<td align="right">0</td>
Line 49:		Line 49:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$~~ALPHNUM~~ ('JOHN SMITH','US')</var>		<p class="code"><var>$alphnum ('JOHN SMITH','US')</var>
	</p></td>		</p></td>
	<td align="right"><var>0</var></td>		<td align="right"><var>0</var></td>
Line 55:		Line 55:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$~~ALPHNUM~~ ('�LE D'ORL�ANS','FRENCHC')</var>		<p class="code"><var>$alphnum ('�LE D'ORL�ANS','FRENCHC')</var>
	</p></td>		</p></td>
	<td align="right"><var>0</var></td>		<td align="right"><var>0</var></td>
Line 61:		Line 61:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$~~ALPHNUM~~ ('12A','US')</var>		<p class="code"><var>$alphnum ('12A','US')</var>
	</p></td>		</p></td>
	<td align="right"><var>1</var></td>		<td align="right"><var>1</var></td>
Line 67:		Line 67:
	<tr>		<tr>
	<td>		<td>
	<p class="code"><var>$~~ALPHNUM~~ ('12A','FRENCHC')</var>		<p class="code"><var>$alphnum ('12A','FRENCHC')</var>
	</p></td>		</p></td>
	<td align="right"><var>1</var></td>		<td align="right"><var>1</var></td>
	</tr>		</tr>
	</table>		</table>
	<p>In the following example, the request sorts by name and processes records whose designated field value does not meet the $~~ALPHNUM~~ criteria. The second argument in the $~~ALPHNUM~~ call instructs <var class="product">Model 204</var> to use French Canadian to perform the validation:</p>		<p>In the following example, the request sorts by name and processes records whose designated field value does not meet the $Alphnum criteria. The second argument in the $Alphnum call instructs <var class="product">Model 204</var> to use French Canadian to perform the validation:</p>
	<p class="code">BEGIN		<p class="code">BEGIN
	%SEARCH = $READ('ENTER FIELD NAME')		%SEARCH = $READ('ENTER FIELD NAME')
Line 80:		Line 80:
	PLACE RECORDS IN FIND.RECS ON LIST BAD		PLACE RECORDS IN FIND.RECS ON LIST BAD
	FOR EACH RECORD IN FIND.RECS		FOR EACH RECORD IN FIND.RECS
	IF $~~ALPHNUM~~(%%SEARCH,'FRENCHC') THEN		IF $alphnum(%%SEARCH,'FRENCHC') THEN
	REMOVE RECORD FROM LIST BAD		REMOVE RECORD FROM LIST BAD
	END IF		END IF
Line 91:		Line 91:
	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, $Alpha and $Alphnum do not recognize lowercase English letters as alphabetic characters unless a non-null language parameter is specified.</p>
	[[Category:SOUL $functions]]		[[Category:SOUL $functions]]