$FlsChk - Revision history

JAL: misc cleanup

2015-06-08T16:04:40Z

misc cleanup

← Older revision		Revision as of 16:04, 8 June 2015
Line 1:		Line 1:
	<p>The $~~FLSCHK~~ function, combined with the $~~FLSACC~~ function, allows a request to check for field-level security access violations before they occur. $~~FLSCHK~~ is designed for use with the IF statement and can determine whether a given set of field-level security accesses is valid for a specified field or for all fields in a file or group. The function returns a 1 if the specified set of accesses is valid. </p>		<p>
	~~<b>~~Syntax~~</b>~~		The <var>$FlsChk</var> function, combined with the <var>[[$FlsAcc]]</var> function, allows a request to check for field-level security access violations before they occur. <var>$FlsChk</var> is designed for use with the IF statement and can determine whether a given set of field-level security accesses is valid for a specified field or for all fields in a file or group. The function returns a 1 if the specified set of accesses is valid. </p>
	<p>The format of the $~~FLSCHK~~ function is:</p>
	<p class="~~code~~">$~~FLSCHK~~ (fieldname, access <~~var~~>[<~~/var~~>,filename<~~var~~>])~~</var>~~		==Syntax==
			<p>
			The format of the <var>$FlsChk</var> function is:</p>
			<p class="syntax">$Flschk (<span class="term">fieldname</span>, <span class="term">access</span> [, <span class="term">filename</span>])
	</p>		</p>
	<ul>		<ul>
	<li>fieldname is a character string representing the name of the field whose access is to be checked. ~~</li>~~		<li><var class="term">fieldname</var> is a character string representing the name of the field whose access is to be checked.
	<p>If the field name is omitted or null, every field in the file or group is checked; the function returns a 1 only if the access is allowed for every field in the file or group. This use of $~~FLSHCK~~ can be costly system overhead since all field descriptions must be examined.</p>		<p>If the field name is omitted or null, every field in the file or group is checked; the function returns a 1 only if the access is allowed for every field in the file or group. This use of <var>$FlsChk</var> can be costly system overhead since all field descriptions must be examined.</p>
	~~</li>~~
	~~<li>access is the desired access or set of accesses; the argument can include: </li~~>
	</li>		</li>

			<li>access is the desired access or set of accesses; the argument can include:
			<ul>
			<li><var>S</var> (SELECT)</li>
			<li><var>R</var> (READ)</li>
			<li><var>U</var> (UPDATE)</li>
			<li><var>A</var> (ADD)</li>
	</ul>		</ul>
	<p>S ~~(SELECT)~~</p>		<p>
	<p>R ~~(READ)~~</p>		If the access argument contains an invalid character (not <var>S</var>, <var>R</var>, <var>U</var>, or <var>A</var>), a warning message is issued and 0 is returned. If a set of accesses is specified, such as <code>SR</code>, a 1 is returned only if all accesses in the set are allowed for the indicated field or fields.</p>
	<p>U ~~(UPDATE)~~</p>
	<p>A ~~(ADD)~~</p>
	<p>~~If the access argument contains an invalid character (not S, R, U, or A~~), a warning message is issued and 0 is returned. If a set of accesses is specified, such as SR, a 1 is returned only if all accesses in the set are allowed for the indicated field or fields.</p>
	~~<ul>~~
	<li>filename is optional and can be used to control the file or group context of the function. The format for the filename argument is identical to the name argument described earlier for the $FLSACC function. For single file context, the field level security access rights are well defined. In group context, this function returns a 1 if the indicated access would compile without error. If access for the current file of a FOR loop is desired, $CURFILE can be used as the third argument. If this argument is omitted or null, the context used for the check is the context of the statement containing the function. </li>
	</li>		</li>

			<li><var class="term">filename</var> is optional and can be used to control the file or group context of the function. The format for the <var class="term">filename</var> argument is identical to the <var>[[$FlsAcc]]</var> <var class="term">name</var> argument.
			<p>
			For single file context, the field level security access rights are well defined. In group context, this function returns a 1 if the indicated access would compile without error. </p>
			<p>
			If you want to access the current file of a <var>For</var> loop, use <var>[[$Curfile]]</var> as the third argument. </p>
			<p>
			If this argument is omitted or null, the context used for the check is the context of the statement containing the function. </p></li>
	</ul>		</ul>

	[[Category:SOUL $functions]]		[[Category:SOUL $functions]]

Mlarocca: Mlarocca moved page $FLSCHK to $FlsChk: Lower case change

2014-07-21T17:46:42Z

Mlarocca moved page $FLSCHK to $FlsChk: Lower case change

← Older revision	Revision as of 17:46, 21 July 2014
(No difference)

Alex: Automatically generated page update

2013-04-20T13:19:04Z

Automatically generated page update

New page

The $FLSCHK function, combined with the $FLSACC function, allows a request to check for field-level security access violations before they occur. $FLSCHK is designed for use with the IF statement and can determine whether a given set of field-level security accesses is valid for a specified field or for all fields in a file or group. The function returns a 1 if the specified set of accesses is valid. 
Syntax
The format of the $FLSCHK function is:
$FLSCHK (fieldname, access <var>[</var>,filename<var>])</var>

<ul>
<li>fieldname is a character string representing the name of the field whose access is to be checked. </li>
If the field name is omitted or null, every field in the file or group is checked; the function returns a 1 only if the access is allowed for every field in the file or group. This use of $FLSHCK can be costly system overhead since all field descriptions must be examined.
</li>
<li>access is the desired access or set of accesses; the argument can include: </li>
</li>
</ul>
S (SELECT)
R (READ)
U (UPDATE)
A (ADD)
If the access argument contains an invalid character (not S, R, U, or A), a warning message is issued and 0 is returned. If a set of accesses is specified, such as SR, a 1 is returned only if all accesses in the set are allowed for the indicated field or fields.
<ul>
<li>filename is optional and can be used to control the file or group context of the function. The format for the filename argument is identical to the name argument described earlier for the $FLSACC function. For single file context, the field level security access rights are well defined. In group context, this function returns a 1 if the indicated access would compile without error. If access for the current file of a FOR loop is desired, $CURFILE can be used as the third argument. If this argument is omitted or null, the context used for the check is the context of the statement containing the function. </li>
</li>
</ul>
[[Category:SOUL $functions]]