TranOut (Socket function) - Revision history

JAL2: /* Examples */

2012-06-11T19:13:42Z

Examples

← Older revision		Revision as of 19:13, 11 June 2012
Line 38:		Line 38:

	==Examples==		==Examples==
	<ul>		<ol>
	<li>In the following example, database fields only are translated and sent to the remote.		<li>In the following example, database fields only are translated and sent to the remote.
	<p class="code">%sock is Object <var>Socket</var>		<p class="code">%sock is Object <var>Socket</var>
Line 59:		Line 59:
	...		...
	</p>		</p>
	</ul>		</ol>

	{{Template:Socket:TranOut footer}}		{{Template:Socket:TranOut footer}}

JAL2: /* Syntax terms */

2011-11-15T02:07:11Z

Syntax terms

← Older revision		Revision as of 02:07, 15 November 2011
Line 12:		Line 12:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~str~~		<tr><th>%string
	</th><td>String that is to contain the translation of the input string into the remote character set.		</th><td>String that is to contain the translation of the input string into the remote character set.
	</td></tr>		</td></tr>

JALWiccan: 1 revision

2011-11-15T01:23:47Z

1 revision

← Older revision	Revision as of 01:23, 15 November 2011
(No difference)

JAL2 at 01:23, 15 November 2011

2011-11-15T01:23:45Z

← Older revision		Revision as of 01:23, 15 November 2011
Line 15:		Line 15:
	</th><td>String that is to contain the translation of the input string into the remote character set.		</th><td>String that is to contain the translation of the input string into the remote character set.
	</td></tr>		</td></tr>
	<tr><th>~~%socko~~		<tr><th>socket
	</th><td>A variable or an expression that is a reference to a <var>Socket</var> object.		</th><td>A variable or an expression that is a reference to a <var>Socket</var> object.
	</td></tr>		</td></tr>

JAL2 at 23:21, 14 November 2011

2011-11-14T23:21:01Z

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

	This method translates an individual string,		This method translates an individual string,
Line 13:		Line 8:

	==Syntax==		==Syntax==
	~~<p class="syntax">%str = %socko~~:TranOut~~(string)~~		{{Template:Socket:TranOut syntax}}
	~~</p>~~
			===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%str		<tr><th>%str
Line 64:		Line 60:
	</p>		</p>
	</ul>		</ul>

			{{Template:Socket:TranOut footer}}

Admin: 1 revision

2011-11-08T21:35:42Z

1 revision

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

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

2011-11-08T19:34:04Z

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

New page

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

This method translates an individual string,
from the local internal character set (EBCDIC),
to the character set of the remote.
Designed for cases where translation needs to be selective, the <var>TranOut</var> function
has an effect similar to its equivalent $function, <var>$Sock_Tran_Out</var>.

==Syntax==
<p class="syntax">%str = %socko:TranOut(string)
</p>
<table class="syntaxTable">
<tr><th>%str
</th><td>String that is to contain the translation of the input string into the remote character set.
</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>string
</th><td>The string that is to be translated to the remote character set.
</td></tr></table>

==Usage notes==
<ul>
<li>The translate table <var>TranOut</var> uses is the input table
defined by the <var>[[XTAB]]</var> parameter of the socket.
<li>The <var>TranOut</var> method can cause a jump to
the <var>ONRESET</var> label or request cancellation, and it can set the last error information,
but it does not return any error indication.
<li>The <var>TranOut</var> method continues with the next statement if <code>ONRESET
CONTINUE</code>, <code>CANCELC</code>, or <code>LABELC</code> is in effect for the socket.
It always returns the translated string; it never returns an error indicator.
<li>Typically, <var>TranOut</var> is used to translate from EBCDIC
strings that are sent to non-mainframe sources that use other
character mapping schemes, like ASCII or non-English character sets.
</ul>

==Examples==
<ul>
<li>In the following example, database fields only are translated and sent to the remote.
<p class="code">%sock is Object <var>Socket</var>
%sock = New
%old = %sock:Set('BINARY')
For Each Record
%xlate = %sock:TranOut(DATA_FIELD)
%rc = %sock:SendWithLineEnd(%xlate)
End For
%old = %sock:Set('BINARY', %old)
</p>
<li><var>TranOut</var> can be useful if you want to use a "normal" character as either the <var>LINEND</var> or
<var>PRSTOK</var> value (see <var>[[Set (Socket function)|Set]]</var>) for communication with the remote.
In the following example, <var>LINEND</var> is set to a pair of plus sign (<tt>+</tt>) characters:
<p class="code">Begin
%sock is Object <var>Socket</var>
%sock = New('SOCKEM')
%s = %sock:TranOut('++')
%t = %sock:Set('LINEND', %s)
...
</p>
</ul>