$Field Image - Revision history

JAL: add link

2018-01-30T23:24:27Z

add link

← Older revision		Revision as of 23:24, 30 January 2018
Line 4:		Line 4:
	<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$Field_Image</var> function.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$Field_Image</var> function.</p>

	<var>$Field_Image</var> retrieves single-occurrence fields or fields in a repeating group into an image. It provides an alternative to <var>PAI INTO</var>.		<var>$Field_Image</var> retrieves single-occurrence fields or fields in a repeating group into an [[Images\|image]]. It provides an alternative to <var>PAI INTO</var>.

	The <var>$Field_Image</var> function accepts four arguments and returns a number indicating the success of the function.		The <var>$Field_Image</var> function accepts four arguments and returns a number indicating the success of the function.

JAL: add prod authorization

2018-01-30T23:08:51Z

add prod authorization

← Older revision		Revision as of 23:08, 30 January 2018
Line 138:		Line 138:
	<p class="code"> %RC = $Field_Image('ORDERINFO', , , , '_NULL_')		<p class="code"> %RC = $Field_Image('ORDERINFO', , , , '_NULL_')
	</p></li>		</p></li>
			</ul>

			==Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
			<li>[[Sirius Functions]]</li>
	</ul>		</ul>

	[[Category:$Functions\|$Field_Image]]		[[Category:$Functions\|$Field_Image]]

JAL: misc cleanup

2018-01-30T20:08:00Z

misc cleanup

← Older revision		Revision as of 20:08, 30 January 2018
Line 105:		Line 105:

	<li>The first argument to <var>$Field_Image</var> can have a blank after the image name (and optional occurrence item name) followed by a prefix to be prepended to each image item name in generating field names.		<li>The first argument to <var>$Field_Image</var> can have a blank after the image name (and optional occurrence item name) followed by a prefix to be prepended to each image item name in generating field names.
	For example, before ~~<var class="product">[[Sirius Mods]]</var> Version 6.3~~, if a file had fields in a repeating group called ORDERDATA.PRODID, ORDERDATA.QUANTITY and ORDERDATA.PRICE an image definition used with <var>$Field_Image</var> would need to look something like		<p>
			For example, before such a blank was allowed, if a file had fields in a repeating group that were called <code>ORDERDATA.PRODID</code>, <code>ORDERDATA.QUANTITY</code>, and <code>ORDERDATA.PRICE</code>, an image definition used with <var>$Field_Image</var> would need to look something like this:
			</p>
	<p class="code">IMAGE ORDERINFO		<p class="code">IMAGE ORDERINFO
	ORDERDATA.PRODID IS STRING LEN 8		ORDERDATA.PRODID IS STRING LEN 8
	ORDERDATA.QUANTITY IS BINARY LEN 4		ORDERDATA.QUANTITY IS BINARY LEN 4
	ORDERDATA.PRICE IS BINARY LEN 4		ORDERDATA.PRICE IS BINARY LEN 4
	END IMAGE		END IMAGE </p>
	</p>		<p>
			But then the following statement would result in "ugly" looking image item names like <code>%ORDERINFO:ORDERDATA.PRODID</code>: </p>
	~~so you could do~~
	<p class="code">%rc = $Field_Image('ORDERINFO', %OCC)		<p class="code">%rc = $Field_Image('ORDERINFO', %OCC)
	</p>		</p>
	~~which means you'd have "ugly" looking image item names like %ORDERINFO:ORDERDATA.PRODID.~~		With a prefix allowed, the <var>$Field_Image</var> call can be this:
	~~By specifying~~ a prefix ~~in this~~ <var>$Field_Image</var> call
	<p class="code">%rc = $Field_Image('ORDERINFO ORDERDATA.', %OCC)		<p class="code">%rc = $Field_Image('ORDERINFO ORDERDATA.', %OCC)
	</p>		</p>
	the image definition ~~could~~ be simplified to		And the image definition can be simplified to:
	<p class="code">IMAGE ORDERINFO		<p class="code">IMAGE ORDERINFO
	PRODID IS STRING LEN 8		PRODID IS STRING LEN 8
Line 128:		Line 127:
	END IMAGE		END IMAGE
	</p>		</p>
	~~so that~~ the image item references like %ORDERINFO:PRODID are ~~much "nicer"~~. </li>		And the resulting image item references, like <code>%ORDERINFO:PRODID</code>, are simpler. </li>

	<li>The <var class="term">null_value</var> argument indicates a special value to be treated as a null when populating the target image. This is useful because storing nulls in fields is problematic on many fronts in <var class="product">Model 204</var>, so most sites have a special value that acts as a placeholder for a null.		<li>The <var class="term">null_value</var> argument indicates a special value to be treated as a null when populating the target image. This is useful because storing nulls in fields is problematic on many fronts in <var class="product">Model 204</var>, so most sites have a special value that acts as a placeholder for a null.

JAL: minor formatting

2018-01-30T18:47:31Z

minor formatting

← Older revision		Revision as of 18:47, 30 January 2018
Line 17:		Line 17:

	<tr><th>image_id</th>		<tr><th>image_id</th>
	<td>A string containing the name of an image and, optionally, an item in the image separated from the image name with a colon. The image and optional item name can be separated with a blank from an optional fieldname prefix. If an image item name is specified, that item will be set to the occurrence number retrieved. This is a required argument.		<td>A string containing the name of an image, and optionally, an item in the image separated from the image name with a colon. The image and optional item name can be separated with a blank from an optional fieldname prefix. If an image item name is specified, that item will be set to the occurrence number retrieved. This is a required argument.
	<p>		<p>
	The specified image must have been defined with the NAMESAVE option. The image is not allowed to have arrays, cannot have more than 255 items, and cannot be more than the maximum length of $list items (6124 bytes ~~in <var class="product">[[Sirius Mods]]</var> Version 6.2 and later, and 4096 bytes long before~~). </p>		The specified image must have been defined with the <var>NAMESAVE</var> option. The image is not allowed to have arrays, cannot have more than 255 items, and cannot be more than the maximum length of $list items (6124 bytes). </p>
	<p>		<p>
	The names of the image items in the specified image are mapped to fields in the current record context, ~~and~~ then the values of those fields are moved into the image. </p></td></tr>		The names of the image items in the specified image are mapped to fields in the current record context, then the values of those fields are moved into the image. </p></td></tr>

	<tr><th>occ</th>		<tr><th>occ</th>

JAL: misc cleanup

2018-01-30T18:43:39Z

misc cleanup

Show changes

JALWiccan: Automatically generated page update

2013-07-18T20:36:12Z

Automatically generated page update

← Older revision		Revision as of 20:36, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Return field values into an image</span>		<span class="pageSubtitle">Return field values into an image</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Field_Image function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Field_Image function.</p>

	This function retrieves single-occurrence fields or fields in a repeating group into an image. It provides an alternative to PAI INTO.		This function retrieves single-occurrence fields or fields in a repeating group into an image. It provides an alternative to PAI INTO.

JAL at 21:59, 12 April 2013

2013-04-12T21:59:54Z

Show changes

JALWiccan: Automatically generated page update

2013-04-12T21:48:05Z

Automatically generated page update

← Older revision		Revision as of 21:48, 12 April 2013
Line 8:		Line 8:
	The <var>$Field_Image</var> function accepts four arguments and returns a number indicating the success of the function.		The <var>$Field_Image</var> function accepts four arguments and returns a number indicating the success of the function.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_Image</span>(<span class="term">image_id</span>, <span class="term">occ</span>, <span class="term">options</span>, null_value)		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_Image</span>(<span class="term">image_id</span>, <span class="term">occ</span>, <span class="term">options</span>, <span class="term">null_value</span>)
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-12T21:40:18Z

Automatically generated page update

← Older revision		Revision as of 21:40, 12 April 2013
Line 8:		Line 8:
	The <var>$Field_Image</var> function accepts four arguments and returns a number indicating the success of the function.		The <var>$Field_Image</var> function accepts four arguments and returns a number indicating the success of the function.
	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_Image</span>(<span class="term">image_id</span>, <span class="term">occ</span>, options, null_value)		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_Image</span>(<span class="term">image_id</span>, <span class="term">occ</span>, <span class="term">options</span>, null_value)
	</p>		</p>

JAL: /* Syntax */

2013-04-12T20:53:48Z

Syntax

← Older revision		Revision as of 20:53, 12 April 2013
Line 10:		Line 10:
	<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_Image</span>(<span class="term">image_id</span>, <span class="term">occ</span>, options, null_value)		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_Image</span>(<span class="term">image_id</span>, <span class="term">occ</span>, options, null_value)
	</p>		</p>
	~~<p>~~
	~~</p>~~
	<p>%RC is 0 (if occurrence not found) or 1.</p>		<p>%RC is 0 (if occurrence not found) or 1.</p>