$TableC - Revision history

EllieWiccan: Automatically generated page update

2018-09-20T23:23:12Z

Automatically generated page update

← Older revision		Revision as of 23:23, 20 September 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Information provided by TABLEC command</span>		<span class="pageSubtitle">Information provided by TABLEC command</span>

	<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 $TableC function, but you can achieve the same results by capturing the output of a TABLEC command executed in a <var>[[Daemon class\|Daemon]]</var> request into a Stringlist.</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 $TableC function, but you can achieve the same results by capturing the output of a TABLEC command executed in a <var>[[Daemon class\|Daemon]]</var> request into a Stringlist.</p>

	This function allows retrieval of the information provided in the <var>TABLEC</var> command from a <var class="product">User Language</var> program.		This function allows retrieval of the information provided in the <var>TABLEC</var> command from a <var class="product">User Language</var> program.

JAL: /* Products authorizing {{PAGENAMEE}} */

2014-08-13T20:39:24Z

Products authorizing {{PAGENAMEE}}

← Older revision		Revision as of 20:39, 13 August 2014
Line 68:		Line 68:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius ~~$Functions~~]]		<li>[[List of $functions\|Sirius functions]]</li>
	</ul>		</ul>


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

JALWiccan: Automatically generated page update

2013-07-19T18:59:35Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Information provided by TABLEC command</span>		<span class="pageSubtitle">Information provided by TABLEC command</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TableC function, but you can achieve the same results by capturing the output of a TABLEC command executed in a <var>[[Daemon class\|Daemon]]</var> request into a Stringlist.</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 $TableC function, but you can achieve the same results by capturing the output of a TABLEC command executed in a <var>[[Daemon class\|Daemon]]</var> request into a Stringlist.</p>

	This function allows retrieval of the information provided in the <var>TABLEC</var> command from a <var class="product">User Language</var> program.		This function allows retrieval of the information provided in the <var>TABLEC</var> command from a <var class="product">User Language</var> program.

ELowell: /* Syntax terms */

2013-07-01T18:30:17Z

Syntax terms

← Older revision		Revision as of 18:30, 1 July 2013
Line 33:		Line 33:
	</p>		</p>
	<p>		<p>
	See the [[TABLEC command]] and [[Using the TABLEC command in Monitoring]] for more information on the data returned by <var>$TableC</var>.</p></td></tr>		See the [[TABLEC command]] and [[Tuning the hash index#Using the TABLEC command in Monitoring\|Using the TABLEC command in monitoring]] for more information on the data returned by <var>$TableC</var>.</p></td></tr>

	<tr><th>file</th>		<tr><th>file</th>

ELowell: /* Syntax terms */

2013-07-01T18:16:54Z

Syntax terms

← Older revision		Revision as of 18:16, 1 July 2013
Line 33:		Line 33:
	</p>		</p>
	<p>		<p>
	See the ~~<i>~~[~~http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/Model-204-File-Manager/view Rocket Model 204 File Manager's Guide~~]~~</i>~~ for more information on the data returned by <var>$TableC</var>.</p></td></tr>		See the [[TABLEC command]] and [[Using the TABLEC command in Monitoring]] for more information on the data returned by <var>$TableC</var>.</p></td></tr>

	<tr><th>file</th>		<tr><th>file</th>

JALWiccan: Automatically generated page update

2013-04-10T18:17:53Z

Automatically generated page update

← Older revision		Revision as of 18:17, 10 April 2013
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>[%result =] $TableC(image_name, [file])		<p class="syntax">[%result =] $TableC(image_name, [file])
	~~<section end="syntax" />~~</p>		</p>

	===Syntax terms===		===Syntax terms===

JAL at 22:58, 7 December 2012

2012-12-07T22:58:47Z

← Older revision		Revision as of 22:58, 7 December 2012
Line 2:		Line 2:
	<span class="pageSubtitle">Information provided by TABLEC command</span>		<span class="pageSubtitle">Information provided by TABLEC command</span>

	<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TableC function, but you can achieve the same results by capturing the output of a TABLEC command ~~execute~~ in a [[Daemon ~~methods~~\|Daemon]] request into a ~~StringList~~.</p>		<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TableC function, but you can achieve the same results by capturing the output of a TABLEC command executed in a <var>[[Daemon class\|Daemon]]</var> request into a Stringlist.</p>

	This function allows retrieval of the information provided in the <var>TABLEC</var> command from a <var class="product">User Language</var> program.		This function allows retrieval of the information provided in the <var>TABLEC</var> command from a <var class="product">User Language</var> program.

DmeWiccan: 1 revision

2012-11-07T21:33:00Z

1 revision

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

JAL at 21:32, 7 November 2012

2012-11-07T21:32:39Z

← Older revision		Revision as of 21:32, 7 November 2012
Line 66:		Line 66:


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

JAL at 21:25, 29 October 2012

2012-10-29T21:25:13Z

← Older revision		Revision as of 21:25, 29 October 2012
Line 4:		Line 4:
	<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TableC function, but you can achieve the same results by capturing the output of a TABLEC command execute in a [[Daemon methods\|Daemon]] request into a StringList.</p>		<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TableC function, but you can achieve the same results by capturing the output of a TABLEC command execute in a [[Daemon methods\|Daemon]] request into a StringList.</p>

	This function allows retrieval of the information provided in the TABLEC command from a <var class="product">User Language</var> program.		This function allows retrieval of the information provided in the <var>TABLEC</var> command from a <var class="product">User Language</var> program.

	The $TableC function ~~accepts two arguments and returns a number indicating the success of the function. It~~ is ~~also~~ [[Calling Sirius Mods $functions\|callable]].		The <var>$TableC</var> function is [[Calling Sirius Mods $functions\|callable]].

	~~The first argument~~, ~~which is required, is a string identifying an image to receive returned data. This image should have the following format :~~		==Syntax==
			<p class="syntax"><section begin="syntax" />[%result =] $TableC(image_name, [file])
			<section end="syntax" /></p>

	<p class="~~code~~"> ~~IMAGE TABLEC_IMAGE~~		===Syntax terms===
	~~FILE_NAME IS STRING LEN 8~~		<table class="syntaxTable">
	~~SLOTS_TOTAL IS BINARY LEN 4~~		<tr><th>%result</th>
	~~SLOTS_USED IS BINARY LEN 4~~		<td>A numeric variable to receive 0 or an error code.</td></tr>
	~~SLOTS_PCT IS BINARY LEN 4~~
	* FOLLOWING FIELDS SET TO ZERO FOR PRE-8.~~1 FILES~~
	~~PROP_COUNT IS BINARY LEN 4~~
	~~PAGE_SPILL IS BINARY LEN 4~~
	~~PROP_OVFL IS BINARY LEN 4~~
	~~PROP_SPCT IS BINARY LEN 4~~
	~~END IMAGE~~
	</p>

	~~The second~~ argument is ~~the name of the file on which the $TableC function~~ should ~~operate. If this argument is not specified~~ the ~~default file at compilation time is used by $TableC.~~		<tr><th>image_name</th>
			<td>This required argument is a string identifying an image to receive returned data. This image should have the following format :

	~~==Syntax==~~		<p class="code">IMAGE TABLEC_IMAGE
	<p class="~~syntax~~">~~<section begin="syntax" />[%RESULT =] $TableC(image_name, file)~~		FILE_NAME IS STRING LEN 8
	~~<section end="syntax" />~~</p>		SLOTS_TOTAL IS BINARY LEN 4
			SLOTS_USED IS BINARY LEN 4
			SLOTS_PCT IS BINARY LEN 4
			* FOLLOWING FIELDS SET TO ZERO FOR PRE-8.1 FILES
			PROP_COUNT IS BINARY LEN 4
			PAGE_SPILL IS BINARY LEN 4
			PROP_OVFL IS BINARY LEN 4
			PROP_SPCT IS BINARY LEN 4
			END IMAGE
			</p>
	<p>		<p>
	</p>		See the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/Model-204-File-Manager/view Rocket Model 204 File Manager's Guide]</i> for more information on the data returned by <var>$TableC</var>.</p></td></tr>
	<p>~~%result is a 0 or an error code~~.</p>

	~~See~~ the ~~'''Model 204 File Manager's Guide''' for more information~~ on the ~~data returned~~ by $TableC.		<tr><th>file</th>
			<td>The name of the file on which the <var>$TableC</var> function should operate. If this argument is not specified, the default file at compilation time is used by <var>$TableC</var>.</td></tr>
			</table>

	<p class="code">		===Return codes===
	0 - Image filled with Table C information		<p class="code"> 0 - Image filled with Table C information
	4 - File invalid		4 - File invalid
	8 - File not open		8 - File not open
	12 - Image specified by argument 1 not found		12 - Image specified by argument 1 not found
	16 - Image specified by argument 1 not active or too short		16 - Image specified by argument 1 not active or too short
	~~</p>~~
	~~<p class="caption">$TableC return codes~~
	</p>		</p>

	The following program prints the percentage of slots used in ~~table~~ C of file ROSA.		==Example==
	<p class="code"> B		The following program prints the percentage of slots used in Table C of file <code>ROSA</code>.
	IMAGE JUNK		<p class="code">B
	FILE_NAME IS STRING LEN 8		IMAGE JUNK
			FILE_NAME IS STRING LEN 8
	...		...
	END IMAGE		END IMAGE

	PREPARE IMAGE JUNK		PREPARE IMAGE JUNK
	%RC = $TableC('JUNK', 'ROSA')		%RC = $TableC('JUNK', 'ROSA')
	IF %RC ^= 0 THEN		IF %RC ^= 0 THEN
	STOP		STOP
	END IF		END IF
	PRINT %JUNK:SLOTS_PCT		PRINT %JUNK:SLOTS_PCT

	END		END
	</p>		</p>


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

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