$FunsStr - Revision history

JAL: UL Interface becomes SOUL Interface

2015-03-16T20:31:21Z

UL Interface becomes SOUL Interface

← Older revision		Revision as of 20:31, 16 March 2015
Line 29:		Line 29:
	<var>$FunsStr</var> calls can be mixed with <var>$FunSkip</var> and <var>$FunImg</var> calls for the same request. In addition, multiple unloads can be performed simultaneously, and <var>$FunsStr</var> calls for the different requests can be mixed in freely.		<var>$FunsStr</var> calls can be mixed with <var>$FunSkip</var> and <var>$FunImg</var> calls for the same request. In addition, multiple unloads can be performed simultaneously, and <var>$FunsStr</var> calls for the different requests can be mixed in freely.

			==Example==
	In the following example, the first 20 bytes of each unloaded record is assigned to <var class="term">%var1</var>, the second 20 bytes to <var class="term">%var2</var>, and this data is processed with subroutine <code>PROCESS</code>.		In the following example, the first 20 bytes of each unloaded record is assigned to <var class="term">%var1</var>, the second 20 bytes to <var class="term">%var2</var>, and this data is processed with subroutine <code>PROCESS</code>.
	<p class="code">%req = $FunLoad('DATA', , , '*')		<p class="code">%req = $FunLoad('DATA', , , '*')
Line 52:		Line 53:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul>		<ul>
	<li>[[Fast/Unload ~~User Language~~ Interface]]</li>		<li>[[Fast/Unload SOUL Interface]]</li>
	</ul>		</ul>

	[[Category:$Functions\|$FunsStr]]		[[Category:$Functions\|$FunsStr]]
	[[Category:Fast/Unload ~~User Language~~ Interface]]		[[Category:Fast/Unload SOUL Interface]]

JAL: more conversion cleanup

2015-02-24T18:47:10Z

more conversion cleanup

← Older revision		Revision as of 18:47, 24 February 2015
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve data from active Fast/Unload request into string</span>		<span class="pageSubtitle">Retrieve data from active Fast/Unload request into string</span>

	~~This~~ retrieves data from an active <i>[[Fast/Unload]]</i> request into a string.		<var>$FunsStr</var> retrieves data from an active <var class="product">[[Fast/Unload]]</var> request into a string.

	The $FunsStr function accepts three arguments and returns a string result.		The <var>$FunsStr</var> function accepts three arguments and returns a string result.

	~~<ul>~~
	~~<li>The first argument is the request identifier returned by <var>$FunLoad</var> for the request from which data is to be retrieved. This is a required argument.~~
	~~<li>The second argument is the column number in the current <i>[[Fast/Unload]]</i> record from which data is to be retrieved.~~
	~~<li>The third argument is the maximum number of bytes of data to be retrieved from the current <i>[[Fast/Unload]]</i> record.~~
	~~</ul>~~

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%~~STRING~~</span> = <span class="literal">$FunsStr</span>(<span class="term">req_num</span>, <span class="term">start</span>, <span class="term">len</span>)		<p class="syntax"><span class="term">%string</span> = <span class="literal">$FunsStr</span>(<span class="term">req_num</span>, <span class="term">start</span>, <span class="term">len</span>)
	</p>		</p>
	~~<p>~~
	~~</p>~~
	~~<p>%STRING is set to the contents of the current [[Fast/Unload]] record for the request, or to a null if there is some error.</p>~~

	If <i>[[Fast/Unload]]</i> has not unloaded any records yet, $FunsStr will wait for the first record. Each invocation of $FunsStr (with the same request number) operates on the same record, so a record longer than 255 bytes long can be split into multiple strings. To adjust the <i>[[Fast/Unload]]</i> record pointer to the next record, [[$FunSkip]] or [[$FunImg]] must be used. If there are no more records left from <i>[[Fast/Unload]]</i>, $FunsStr will return a null. In this case, [[$FunSkip]] or [[$FunImg]] should be called to obtain the <i>[[Fast/Unload]]</i> return code and clean up after the request.		<table>
			<tr><th>%string</th>
			<td>A string variable set to the contents of the current <var class="product">Fast/Unload</var> record for the request, or to a null if there is some error.</td></tr>

			<tr><th>req_num</th>
			<td>The request identifier returned by <var>$FunLoad</var> for the request from which data is to be retrieved. This is a required argument. </td></tr>

			<tr><th>start</th>
			<td>The column number in the current <var class="product">Fast/Unload</var> record from which data is to be retrieved. </td></tr>

			<tr><th>len</th>
			<td>The maximum number of bytes of data to be retrieved from the current <var class="product">Fast/Unload</var> record.</td></tr>
			</table>

			==Usage notes==
			If <var class="product">Fast/Unload</var> has not unloaded any records yet, <var>$FunsStr</var> will wait for the first record. Each invocation of <var>$FunsStr</var> (with the same request number) operates on the same record, so a record longer than 255 bytes long can be split into multiple strings. To adjust the <var class="product">Fast/Unload</var> record pointer to the next record, <var>[[$FunSkip]]</var> or <var>[[$FunImg]]</var> must be used. If there are no more records left from <var class="product">Fast/Unload</var>, <var>$FunsStr</var> will return a null. In this case, <var>$FunSkip</var> or <var>$FunImg</var> should be called to obtain the <var class="product">Fast/Unload</var> return code and clean up after the request.

	$FunsStr's can be mixed with [[$FunSkip]] and [[$FunImg]] calls for the same request. In addition, multiple unloads can be performed simultaneously, and $FunsStr calls for the different requests can be mixed in freely.		<var>$FunsStr</var> calls can be mixed with <var>$FunSkip</var> and <var>$FunImg</var> calls for the same request. In addition, multiple unloads can be performed simultaneously, and <var>$FunsStr</var> calls for the different requests can be mixed in freely.

	In the following example, the first 20 bytes of each unloaded record is assigned to %~~VAR1~~, the second 20 bytes to %~~VAR2~~, and this data is processed with subroutine PROCESS.		In the following example, the first 20 bytes of each unloaded record is assigned to <var class="term">%var1</var>, the second 20 bytes to <var class="term">%var2</var>, and this data is processed with subroutine <code>PROCESS</code>.
	<p class="code"> %~~REQ~~ = $FunLoad('DATA', , , '*')		<p class="code">%req = $FunLoad('DATA', , , '*')
	IF %~~REQ LE~~ 0 ~~THEN~~		If %req Le 0 Then
	~~STOP~~		Stop
	~~END IF~~		End If

	%RC = 1		%rc = 1
	~~REPEAT WHILE~~ %RC > 0		Repeat While %rc > 0
	%~~VAR1~~ = $FunsStr( %~~REQ~~, 1, 20)		%var1 = $FunsStr(%req, 1, 20)
	%~~VAR2~~ = $FunsStr( %~~REQ~~, 21, 20)		%var2 = $FunsStr(%req, 21, 20)
	IF %~~VAR1 EQ~~ '' ~~THEN~~		If %var1 Eq '' Then
	~~CALL PROCESS~~( %~~VAR1~~, %~~VAR2~~)		Call Process( %var1, %var2)
	~~END IF~~		End If
	%RC = $FunSkip		%rc = $FunSkip
	~~END REPEAT~~		End Repeat
	</p>		</p>

	If any record is shorter than 40 bytes in the preceding example, %~~VAR1~~ and %~~VAR2~~ are truncated as appropriate. If a record were only 20 bytes long, %~~VAR1~~ would be 20 bytes and %~~VAR2~~ would be null. If a record were 60 bytes long, both %~~VAR1~~ and %~~VAR2~~ would be 20 bytes long. If a record were 10 bytes long, %~~VAR1~~ would be 10 bytes long and %~~VAR2~~ would be null.		If any record is shorter than 40 bytes in the preceding example, <var class="term">%var1</var> and <var class="term">%var2</var> are truncated as appropriate. If a record were only 20 bytes long, <var class="term">%var1</var> would be 20 bytes and <var class="term">%var2</var> would be null. If a record were 60 bytes long, both <var class="term">%var1</var> and <var class="term">%var2</var> would be 20 bytes long. If a record were 10 bytes long, <var class="term">%var1</var> would be 10 bytes long and <var class="term">%var2</var> would be null.

	Note that after the last record is processed, $FunsStr always returns a null. At that point, [[$FunSkip]] should still be called once to obtain the <i>[[Fast/Unload]]</i> return code and clean up after the request.		Note that after the last record is processed, <var>$FunsStr</var> always returns a null. At that point, <var>$FunSkip</var> should still be called once to obtain the <var class="product">Fast/Unload</var> return code and clean up after the request.

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul ~~class="smallAndTightList"~~>		<ul>
	<li>[[Fast/Unload User Language Interface]]		<li>[[Fast/Unload User Language Interface]]</li>
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

	[[Category:$Functions\|$FunsStr]]		[[Category:$Functions\|$FunsStr]]
	[[Category:Fast/Unload User Language Interface]]		[[Category:Fast/Unload User Language Interface]]

ELowell at 21:36, 11 November 2014

2014-11-11T21:36:22Z

← Older revision		Revision as of 21:36, 11 November 2014
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve data from active Fast/Unload request into string</span>		<span class="pageSubtitle">Retrieve data from active Fast/Unload request into string</span>

	This retrieves data from an active ''[[Fast/Unload]]'' request into a string.		This retrieves data from an active <i>[[Fast/Unload]]</i> request into a string.

	The $FunsStr function accepts three arguments and returns a string result.		The $FunsStr function accepts three arguments and returns a string result.
Line 8:		Line 8:
	<ul>		<ul>
	<li>The first argument is the request identifier returned by <var>$FunLoad</var> for the request from which data is to be retrieved. This is a required argument.		<li>The first argument is the request identifier returned by <var>$FunLoad</var> for the request from which data is to be retrieved. This is a required argument.
	<li>The second argument is the column number in the current ''[[Fast/Unload]]'' record from which data is to be retrieved.		<li>The second argument is the column number in the current <i>[[Fast/Unload]]</i> record from which data is to be retrieved.
	<li>The third argument is the maximum number of bytes of data to be retrieved from the current ''[[Fast/Unload]]'' record.		<li>The third argument is the maximum number of bytes of data to be retrieved from the current <i>[[Fast/Unload]]</i> record.
	</ul>		</ul>

Line 19:		Line 19:
	<p>%STRING is set to the contents of the current [[Fast/Unload]] record for the request, or to a null if there is some error.</p>		<p>%STRING is set to the contents of the current [[Fast/Unload]] record for the request, or to a null if there is some error.</p>

	If ''[[Fast/Unload]]'' has not unloaded any records yet, $FunsStr will wait for the first record. Each invocation of $FunsStr (with the same request number) operates on the same record, so a record longer than 255 bytes long can be split into multiple strings. To adjust the ''[[Fast/Unload]]'' record pointer to the next record, [[$FunSkip]] or [[$FunImg]] must be used. If there are no more records left from ''[[Fast/Unload]]'', $FunsStr will return a null. In this case, [[$FunSkip]] or [[$FunImg]] should be called to obtain the ''[[Fast/Unload]]'' return code and clean up after the request.		If <i>[[Fast/Unload]]</i> has not unloaded any records yet, $FunsStr will wait for the first record. Each invocation of $FunsStr (with the same request number) operates on the same record, so a record longer than 255 bytes long can be split into multiple strings. To adjust the <i>[[Fast/Unload]]</i> record pointer to the next record, [[$FunSkip]] or [[$FunImg]] must be used. If there are no more records left from <i>[[Fast/Unload]]</i>, $FunsStr will return a null. In this case, [[$FunSkip]] or [[$FunImg]] should be called to obtain the <i>[[Fast/Unload]]</i> return code and clean up after the request.

	$FunsStr's can be mixed with [[$FunSkip]] and [[$FunImg]] calls for the same request. In addition, multiple unloads can be performed simultaneously, and $FunsStr calls for the different requests can be mixed in freely.		$FunsStr's can be mixed with [[$FunSkip]] and [[$FunImg]] calls for the same request. In addition, multiple unloads can be performed simultaneously, and $FunsStr calls for the different requests can be mixed in freely.
Line 33:		Line 33:
	%VAR1 = $FunsStr( %REQ, 1, 20)		%VAR1 = $FunsStr( %REQ, 1, 20)
	%VAR2 = $FunsStr( %REQ, 21, 20)		%VAR2 = $FunsStr( %REQ, 21, 20)
	IF %VAR1 EQ ~~<nowiki>''</nowiki>~~ THEN		IF %VAR1 EQ '' THEN
	CALL PROCESS( %VAR1, %VAR2)		CALL PROCESS( %VAR1, %VAR2)
	END IF		END IF
Line 42:		Line 42:
	If any record is shorter than 40 bytes in the preceding example, %VAR1 and %VAR2 are truncated as appropriate. If a record were only 20 bytes long, %VAR1 would be 20 bytes and %VAR2 would be null. If a record were 60 bytes long, both %VAR1 and %VAR2 would be 20 bytes long. If a record were 10 bytes long, %VAR1 would be 10 bytes long and %VAR2 would be null.		If any record is shorter than 40 bytes in the preceding example, %VAR1 and %VAR2 are truncated as appropriate. If a record were only 20 bytes long, %VAR1 would be 20 bytes and %VAR2 would be null. If a record were 60 bytes long, both %VAR1 and %VAR2 would be 20 bytes long. If a record were 10 bytes long, %VAR1 would be 10 bytes long and %VAR2 would be null.

	Note that after the last record is processed, $FunsStr always returns a null. At that point, [[$FunSkip]] should still be called once to obtain the ''[[Fast/Unload]]'' return code and clean up after the request.		Note that after the last record is processed, $FunsStr always returns a null. At that point, [[$FunSkip]] should still be called once to obtain the <i>[[Fast/Unload]]</i> return code and clean up after the request.

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==

JAL: /* Syntax */

2013-06-05T21:00:55Z

Syntax

← Older revision		Revision as of 21:00, 5 June 2013
Line 33:		Line 33:
	%VAR1 = $FunsStr( %REQ, 1, 20)		%VAR1 = $FunsStr( %REQ, 1, 20)
	%VAR2 = $FunsStr( %REQ, 21, 20)		%VAR2 = $FunsStr( %REQ, 21, 20)
	IF %VAR1 EQ '' THEN		IF %VAR1 EQ <nowiki>''</nowiki> THEN
	CALL PROCESS( %VAR1, %VAR2)		CALL PROCESS( %VAR1, %VAR2)
	END IF		END IF

JALWiccan: Automatically generated page update

2013-04-16T01:59:59Z