$Sock Tran Out - Revision history

JALWiccan: Automatically generated page update

2018-09-21T00:00:38Z

Automatically generated page update

← Older revision		Revision as of 00:00, 21 September 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_Tran_Out}}		{{DISPLAYTITLE:$Sock_Tran_Out}}
	<span class="pageSubtitle">Translate string to remote's character set</span>		<span class="pageSubtitle">Translate string to remote's character set</span>
	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented
	methods. The OO equivalent for <var>$Sock_Tran_Out</var> is the <var>[[TranOut (Socket function)\|TranOut]]</var> method.</p>		methods. The OO equivalent for <var>$Sock_Tran_Out</var> is the <var>[[TranOut (Socket function)\|TranOut]]</var> method.</p>

JAL at 21:59, 23 July 2013

2013-07-23T21:59:24Z

← Older revision		Revision as of 21:59, 23 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Translate string to remote's character set</span>		<span class="pageSubtitle">Translate string to remote's character set</span>
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented
	methods. ~~There is currently no direct~~ OO equivalent for ~~this~~ $function.</p>		methods. The OO equivalent for <var>$Sock_Tran_Out</var> is the <var>[[TranOut (Socket function)\|TranOut]]</var> method.</p>

	<var>$Sock_Tran_Out</var> translates a string,		<var>$Sock_Tran_Out</var> translates a string,

JALWiccan: Automatically generated page update

2013-07-19T18:59:29Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_Tran_Out}}		{{DISPLAYTITLE:$Sock_Tran_Out}}
	<span class="pageSubtitle">Translate string to remote's character set</span>		<span class="pageSubtitle">Translate string to remote's character set</span>
	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented
	methods. There is currently no direct OO equivalent for this $function.</p>		methods. There is currently no direct OO equivalent for this $function.</p>

JAL: /* Examples */

2012-11-08T22:28:43Z

Examples

← Older revision		Revision as of 22:28, 8 November 2012
Line 41:		Line 41:
	<li>In the following example, database fields are translated and sent to the remote:		<li>In the following example, database fields are translated and sent to the remote:
	<p class="code">%old = $Sock_Set(%socket, 'BINARY')		<p class="code">%old = $Sock_Set(%socket, 'BINARY')
	For Each ~~Record~~		For Each record
	%xlate = $Sock_Tran_Out(DATA_FIELD, %socket)		%xlate = $Sock_Tran_Out(DATA_FIELD, %socket)
	%rc = $Sock_SendLn(%socket, %xlate)		%rc = $Sock_SendLn(%socket, %xlate)

Admin: 1 revision

2012-01-20T02:53:46Z

1 revision

← Older revision	Revision as of 02:53, 20 January 2012
(No difference)

JAL at 01:31, 20 January 2012

2012-01-20T01:31:07Z

New page

{{DISPLAYTITLE:$Sock_Tran_Out}}
Translate string to remote's character set
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for this $function.

<var>$Sock_Tran_Out</var> translates a string,
from the local internal character set ("EBCDIC"),
to the character set of the remote.
It is a bit different from other $Sock functions:
<ul>
<li>The socket number is the second argument, not the first.
<li>Although it references a socket number, and it can cause a jump to
the <var>ONRESET</var> label or request cancellation and can set the last error information,
it does not return any error indication.
</ul>

==Syntax==
%string = $Sock_Tran_Out(string, sockNum) 

===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string that is to contain the translation of the input string into the local character set. </td></tr>
<tr><th>string</th>
<td>The string to be translated. </td></tr>
<tr><th>sockNum</th>
<td>The socket number, which has associated with it the translation table used by <var>$Sock_Tran_Out</var>. </td></tr>
</table>

==Usage notes==
<ul>
<li><var>$Sock_Tran_Out</var> continues with the next statement if
<var>ONRESET CONTINUE</var>, <var>CANCELC</var>, or <var>LABELC</var> is in effect for the socket.
It always returns the translated string, it never returns an
error indicator.
<li>Typically, <var>$Sock_Tran_Out</var> is used to translate into ASCII strings from mainframe sources.
</ul>

==Examples==
<ol>
<li>In the following example, database fields are translated and sent to the remote:
%old = $Sock_Set(%socket, 'BINARY')
For Each Record
%xlate = $Sock_Tran_Out(DATA_FIELD, %socket)
%rc = $Sock_SendLn(%socket, %xlate)
End For
%old = $Sock_Set(%socket, 'BINARY', %old)


<li><var>$Sock_Tran_Out</var> can be useful if you wish to use a "normal" character
in either the <var>LINEND</var> or
<var>PRSTOK</var> parameter, since you must specify it in the character set used to
communicate with the remote.
For example, the following sets <var>LINEND</var> to a pair of plus sign (<tt>+</tt>) characters:
Begin
%socket = $Sock_Conn('SOCKEM')
%s = $Sock_Tran_Out('++', %socket)
%t = %SOCK_SET(%socket, 'LINEND', %s)
...


The translate table used is the output table
defined by the XTAB parameter of the socket.
</ol>

[[Category: Janus Sockets $functions]]