Capture (Socket function) - Revision history

JAL2 at 22:57, 14 November 2011

2011-11-14T22:57:26Z

← Older revision		Revision as of 22:57, 14 November 2011
Line 3:		Line 3:
	This method		This method
	specifies whether print output should be sent as lines on a <var class="product">Janus Sockets</var> connection.		specifies whether print output should be sent as lines on a <var class="product">Janus Sockets</var> connection.
	The method, which may be invoked with a ~~CALL~~ statement,		The method, which may be invoked with a <var>Call</var> statement,
	has an effect similar to its equivalent $function,		has an effect similar to its equivalent $function,
	<var>[[$Sock_Capture]]</var>.		<var>[[$Sock_Capture]]</var>.

JAL2 at 22:56, 14 November 2011

2011-11-14T22:56:51Z

← Older revision		Revision as of 22:56, 14 November 2011
Line 1:		Line 1:
			{{Template:Socket:Capture subtitle}}
	~~<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>~~
	~~[[Category~~:Socket ~~methods\|Capture function]]~~
	~~<p>~~
	~~<var>~~Capture~~</var> is a member of the <var>[[Socket class\|Socket]]</var> class.~~
	~~</p>~~


	This method		This method
Line 12:		Line 6:
	has an effect similar to its equivalent $function,		has an effect similar to its equivalent $function,
	<var>[[$Sock_Capture]]</var>.		<var>[[$Sock_Capture]]</var>.

	==Syntax==		==Syntax==
	~~<p class="syntax">[%str =] %socko~~:Capture~~(value)~~		{{Template:Socket:Capture syntax}}
	~~</p>~~

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~str~~</th>		<tr><th>%string</th>
	<td>Optional return string, which contains the value of the socket's previous print capture setting. If the socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket, <var>Capture</var> returns the string <code>RESET</code>. For information about <code>ONRESET CONTINUE</code>, see the <var>[[Set (Socket function)\|Set]]</var> method.		<td>Optional return string, which contains the value of the socket's previous print capture setting. If the socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket, <var>Capture</var> returns the string <code>RESET</code>. For information about <code>ONRESET CONTINUE</code>, see the <var>[[Set (Socket function)\|Set]]</var> method.
	</td></tr>		</td></tr>
	<tr><th>~~%socko~~</th>		<tr><th>socket</th>
	<td>A variable or an expression that is a reference to a <var>Socket</var> object.		<td>A variable or an expression that is a reference to a <var>Socket</var> object.
	</td></tr>		</td></tr>
	<tr><th>~~value~~</th>		<tr><th>string</th>
	<td>The print capture setting for the socket. It is a string whose valid values are:		<td>The print capture setting for the socket. It is a string whose valid values are:
	<table>		<table>

JAL2: /* Usage notes */

2011-11-14T22:53:56Z

Usage notes

← Older revision		Revision as of 22:53, 14 November 2011
Line 46:		Line 46:
	For information about "print" output, see [[$Sock_Capture#Print capturing hierarchy and other considerations\|"Print		For information about "print" output, see [[$Sock_Capture#Print capturing hierarchy and other considerations\|"Print
	capturing hierarchy and other considerations"]].		capturing hierarchy and other considerations"]].

			{{Template:Socket:Capture footer}}

JAL2: /* Syntax terms */

2011-11-08T21:46:23Z

Syntax terms

← Older revision		Revision as of 21:46, 8 November 2011
Line 25:		Line 25:
	</td></tr>		</td></tr>
	<tr><th>value</th>		<tr><th>value</th>
	<td>The print capture setting for the socket. It is a string whose valid values are: <table> <tr><th>OFF </th><td>Do not capture print output to this socket.		<td>The print capture setting for the socket. It is a string whose valid values are:
	</td></tr>		<table>
	<tr><th>ON		<tr><th><var>OFF</var> </th>
	</th><td>Capture print output to this socket.		<td>Do not capture print output to this socket. </td></tr>
	</td></tr></table>		<tr><th><var>ON</var> </th>
			<td>Capture print output to this socket. </td></tr>
			</table>
	</td></tr></table>		</td></tr></table>

Admin: 1 revision

2011-11-08T21:35:41Z

1 revision

← Older revision	Revision as of 21:35, 8 November 2011
(No difference)

198.242.244.47: Created page with "
Capture function
`Capture` is a member of the `[[..."`

2011-11-08T19:33:57Z

Created page with " <span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> Capture function <p> <var>Capture</var> is a member of the <var>[[..."

New page

<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:Socket methods|Capture function]]
<p>
<var>Capture</var> is a member of the <var>[[Socket class|Socket]]</var> class.
</p>

This method
specifies whether print output should be sent as lines on a <var class="product">Janus Sockets</var> connection.
The method, which may be invoked with a CALL statement,
has an effect similar to its equivalent $function,
<var>[[$Sock_Capture]]</var>.
==Syntax==
<p class="syntax">[%str =] %socko:Capture(value)
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%str</th>
<td>Optional return string, which contains the value of the socket's previous print capture setting. If the socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket, <var>Capture</var> returns the string <code>RESET</code>. For information about <code>ONRESET CONTINUE</code>, see the <var>[[Set (Socket function)|Set]]</var> method.
</td></tr>
<tr><th>%socko</th>
<td>A variable or an expression that is a reference to a <var>Socket</var> object.
</td></tr>
<tr><th>value</th>
<td>The print capture setting for the socket. It is a string whose valid values are: <table> <tr><th>OFF </th><td>Do not capture print output to this socket.
</td></tr>
<tr><th>ON
</th><td>Capture print output to this socket.
</td></tr></table>
</td></tr></table>

==Usage notes==
<ul>
<li>Unlike <var>$Sock_Capture</var>, capturing to multiple sockets
is '''not''' supported with a <var>Socket</var> object.
<li>Each captured print line is followed by a <var>LINEND</var> string,
if the socket has one set in its definition or by the <var>Set</var> method.
<li>If <var>FIN</var> is sent (using either the <var>Send</var> or <var>SendWithLineEnd</var> method),
print capturing is automatically turned <var>OFF</var> for the socket.
</ul>

For information about "print" output, see [[$Sock_Capture#Print capturing hierarchy and other considerations|"Print
capturing hierarchy and other considerations"]].