$FunImg - Revision history

JAL: misc cleanup

2015-03-16T19:47:05Z

misc cleanup

← Older revision		Revision as of 19:47, 16 March 2015
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve data from active Fast/Unload request into image</span>		<span class="pageSubtitle">Retrieve data from active Fast/Unload request into image</span>

	This retrieves data from an active <i>[[Fast/Unload]]</i> request into an image.		This retrieves data from an active <var class="product">[[Fast/Unload]]</var> request into an image.

	The first argument is the request identifier returned by [[$FunLoad]] for the request from which data is to be retrieved. This is a required argument.		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.

			The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more <var class="product">Fast/Unload</var> data is available in the current record.

	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more <i>[[Fast/Unload]]</i> data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term">image_item</span>)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term">image_item</span>)
Line 12:		Line 13:

	<p>		<p>
	<var class="term">%result</var> is set either ~~to the number~~ of ~~bytes returned, or to an error code if no data was returned.~~</p>		<var class="term">%result</var> is set to either of these: </p>
	<~~p class="code"~~>		<ul>
	>~~0 - Number~~ of bytes ~~in unloaded record~~		<li>The number of bytes returned </li>
	~~0 - &FUNL completed with return code 0; no more data~~
	~~-1 - Request not found~~
	~~-2 - Invalid image item~~
	~~<-2 - &FUNL completed with non-zero return code, value~~
	returned ~~is negative of return code; no more data~~
	~~</p>~~
	~~<p class="caption">$FunImg Error Codes~~
	</p>

	If <i>[[Fast/Unload]]</i> ~~has~~ not ~~unloaded any records yet,~~ <var>~~$FunImg~~</var> ~~will wait for the first record. Each invocation~~ of <~~var~~>~~$FunImg~~</~~var~~> ~~skips over the record processed so that the next invocation will retrieve the next unloaded record.~~		<li>An error code if no data was returned:
			<p class="code"> >0 - Number of bytes in unloaded record
			0 — <var class="product">Fast/Unload</var> completed with return code 0; no more data
			-1 — Request not found
			-2 — Invalid image item
			<-2 — <var class="product">Fast/Unload</var> completed with non-zero return code, and value returned
			is negative of return code; no more data </p></li>
			</ul>

	$FunImg~~'s can be mixed with [[$FunSkip]] and [[$FunsStr]] calls~~ for the ~~same request~~. ~~In addition, multiple unloads can be performed simultaneously with~~ <var>$FunImg</var> ~~calls for~~ the ~~different requests mixed freely~~.		==Usage notes==
			<ul>
			<li>If <var class="product">Fast/Unload</var> has not unloaded any records yet, <var>$FunImg</var> waits for the first record. Each invocation of <var>$FunImg</var> skips over the record processed, so the next invocation retrieves the next unloaded record. </li>

	~~For example~~		<li><var>$FunImg</var> calls can be mixed with <var>[[$FunSkip]]</var> and <var>[[$FunsStr]]</var> calls for the same request. In addition, multiple unloads can be performed simultaneously with <var>$FunImg</var> calls for the different requests mixed freely. </li>
	<p class="code">		</ul>
	%~~REQ~~ = $FunLoad('DATA', , , '*')
	IF %~~REQ LE~~ 0 ~~THEN~~		==Example==
	~~STOP~~		This fragment starts an unload request and then returns the first record into image <code>IMAGE</code>, starting at item <code>ITEM</code> in the image:
	~~END IF~~		<p class="code">%req = $FunLoad('DATA', , , '*')
			If %req le 0 then
	%RC = $FunImg( %~~REQ~~, %~~IMAGE~~:ITEM )		Stop
			End if
			%rc = $FunImg( %req, %image:ITEM )
	</p>		</p>
	~~starts an unload request and then returns the first record into image 'IMAGE', starting at item 'ITEM' in the image.~~ If the record is shorter than the rest of the image (starting at 'ITEM'), then only as much data as is in the <i>[[Fast/Unload]]</i> record is used to overlay the image. All other data in the image is left unchanged. If the record is longer than the rest of the image, the record is truncated before overlaying the image. In all cases, when %RC is positive, it contains the length of the original <i>[[Fast/Unload]]</i> record.<p>
			If the record is shorter than the rest of the image (starting at <code>ITEM</code>), then only as much data as is in the <var class="product">Fast/Unload</var> record is used to overlay the image. All other data in the image is left unchanged. If the record is longer than the rest of the image, the record is truncated before overlaying the image. In all cases, when <var class="term">%rc</var> is positive, it contains the length of the original <var class="product">Fast/Unload</var> record.<p>

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

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

ELowell at 21:39, 11 November 2014

2014-11-11T21:39:32Z

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

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

	The first argument is the request identifier returned by [[$FunLoad]] for the request from which data is to be retrieved. This is a required argument.		The first argument is the request identifier returned by [[$FunLoad]] for the request from which data is to be retrieved. This is a required argument.

	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.		The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more <i>[[Fast/Unload]]</i> data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term">image_item</span>)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term">image_item</span>)
Line 24:		Line 24:
	</p>		</p>

	If ''[[Fast/Unload]]'' has not unloaded any records yet, <var>$FunImg</var> will wait for the first record. Each invocation of <var>$FunImg</var> skips over the record processed so that the next invocation will retrieve the next unloaded record.		If <i>[[Fast/Unload]]</i> has not unloaded any records yet, <var>$FunImg</var> will wait for the first record. Each invocation of <var>$FunImg</var> skips over the record processed so that the next invocation will retrieve the next unloaded record.

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

	</p>		</p>
	starts an unload request and then returns the first record into image 'IMAGE', starting at item 'ITEM' in the image. If the record is shorter than the rest of the image (starting at 'ITEM'), then only as much data as is in the ''[[Fast/Unload]]'' record is used to overlay the image. All other data in the image is left unchanged. If the record is longer than the rest of the image, the record is truncated before overlaying the image. In all cases, when %RC is positive, it contains the length of the original ''[[Fast/Unload]]'' record.<p>		starts an unload request and then returns the first record into image 'IMAGE', starting at item 'ITEM' in the image. If the record is shorter than the rest of the image (starting at 'ITEM'), then only as much data as is in the <i>[[Fast/Unload]]</i> record is used to overlay the image. All other data in the image is left unchanged. If the record is longer than the rest of the image, the record is truncated before overlaying the image. In all cases, when %RC is positive, it contains the length of the original <i>[[Fast/Unload]]</i> record.<p>

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

JALWiccan: Automatically generated page update

2013-04-12T18:43:13Z

Automatically generated page update

← Older revision		Revision as of 18:43, 12 April 2013
Line 8:		Line 8:
	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.		The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, ~~<span class="term"></span>~~<span class="term">image_item</span>)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term">image_item</span>)
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-12T18:30:33Z

Automatically generated page update

← Older revision		Revision as of 18:30, 12 April 2013
Line 8:		Line 8:
	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.		The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term">image_item</span>)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term"></span><span class="term">image_item</span>)
	</p>		</p>

JAL: /* Syntax */

2013-04-10T22:27:49Z

Syntax

← Older revision		Revision as of 22:27, 10 April 2013
Line 8:		Line 8:
	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.		The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num, image_item)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num</span>, <span class="term">image_item</span>)
	</p>		</p>

	<p>		<p>
	</p>		<var class="term">%result</var> is set either to the number of bytes returned, or to an error code if no data was returned.</p>
	<p>~~%result~~ is set either to the number of bytes returned, or to an error code if no data was returned.</p>
	<p class="code">		<p class="code">
	>0 - Number of bytes in unloaded record		>0 - Number of bytes in unloaded record

JALWiccan: Automatically generated page update

2013-04-10T21:52:14Z

Automatically generated page update

← Older revision		Revision as of 21:52, 10 April 2013
Line 8:		Line 8:
	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.		The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = $FunImg(req_num, image_item)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunImg</span>(<span class="term">req_num, image_item)
	</p>		</p>
	<p>		<p>

JALWiccan: Automatically generated page update

2013-04-10T21:28:32Z

Automatically generated page update

← Older revision		Revision as of 21:28, 10 April 2013
Line 8:		Line 8:
	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.		The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax">%result = $FunImg(req_num, image_item)		<p class="syntax"><span class="term">%result</span> = $FunImg(req_num, image_item)
	</p>		</p>
	<p>		<p>

JALWiccan: Automatically generated page update

2013-04-10T18:16:52Z

Automatically generated page update

← Older revision		Revision as of 18:16, 10 April 2013
Line 8:		Line 8:
	The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.		The second argument is the image item to which data is to be returned. Data is returned starting at that image item and continuing to the end of the image or until no more ''[[Fast/Unload]]'' data is available in the current record.
	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>%result = $FunImg(req_num, image_item)		<p class="syntax">%result = $FunImg(req_num, image_item)
	~~<section end="syntax" />~~</p>		</p>
	<p>		<p>
	</p>		</p>

DmeWiccan: 1 revision

2012-11-07T21:32:43Z

1 revision

← Older revision	Revision as of 21:32, 7 November 2012
(No difference)

JALWiccan: 1 revision

2012-11-07T21:32:39Z

1 revision

← Older revision		Revision as of 21:32, 7 November 2012
Line 40:		Line 40:
	starts an unload request and then returns the first record into image 'IMAGE', starting at item 'ITEM' in the image. If the record is shorter than the rest of the image (starting at 'ITEM'), then only as much data as is in the ''[[Fast/Unload]]'' record is used to overlay the image. All other data in the image is left unchanged. If the record is longer than the rest of the image, the record is truncated before overlaying the image. In all cases, when %RC is positive, it contains the length of the original ''[[Fast/Unload]]'' record.<p>		starts an unload request and then returns the first record into image 'IMAGE', starting at item 'ITEM' in the image. If the record is shorter than the rest of the image (starting at 'ITEM'), then only as much data as is in the ''[[Fast/Unload]]'' record is used to overlay the image. All other data in the image is left unchanged. If the record is longer than the rest of the image, the record is truncated before overlaying the image. In all cases, when %RC is positive, it contains the length of the original ''[[Fast/Unload]]'' record.<p>

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