$Sock Tran In - Revision history

JALWiccan: Automatically generated page update

2018-09-21T00:00:37Z

Automatically generated page update

← Older revision		Revision as of 00:00, 21 September 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_Tran_In}}		{{DISPLAYTITLE:$Sock_Tran_In}}
	<span class="pageSubtitle">Translate string from remote's character set</span>		<span class="pageSubtitle">Translate string from 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_In</var> is the <var>[[TranIn (Socket function)\|TranIn]]</var> method.</p>		methods. The OO equivalent for <var>$Sock_Tran_In</var> is the <var>[[TranIn (Socket function)\|TranIn]]</var> method.</p>
	[[Category: Janus Sockets $functions]]		[[Category: Janus Sockets $functions]]

JAL at 21:58, 23 July 2013

2013-07-23T21:58:29Z

← Older revision		Revision as of 21:58, 23 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Translate string from remote's character set</span>		<span class="pageSubtitle">Translate string from 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_In</var> is the <var>[[TranIn (Socket function)\|TranIn]]</var> method.</p>
	[[Category: Janus Sockets $functions]]		[[Category: Janus Sockets $functions]]

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_In}}		{{DISPLAYTITLE:$Sock_Tran_In}}
	<span class="pageSubtitle">Translate string from remote's character set</span>		<span class="pageSubtitle">Translate string from 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>
	[[Category: Janus Sockets $functions]]		[[Category: Janus Sockets $functions]]

Admin: 1 revision

2012-01-20T02:53:46Z

1 revision

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

JAL: /* Example */

2012-01-20T01:26:20Z

Example

New page

{{DISPLAYTITLE:$Sock_Tran_In}}
Translate string from 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.
[[Category: Janus Sockets $functions]]

<var>$Sock_Tran_In</var> translates a string,
from the character set of the remote, to the local internal character set (EBCDIC).
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_In(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_In</var>. </td></tr>
</table>

==Usage notes==
<ul>
<li><var>$Sock_Tran_In</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 the <var>$Sock_Tran_In</var> function is used to translate into EBCDIC
strings that are received from non-mainframe sources that use other
character mapping schemes, like ASCII or non-English character sets.
</ul>
==Example==
In the following example, parsed lines are received into the <code>%s</code> variable,
then translated, and printed in EBCDIC.
The translate table used is the input table
defined by the <var>[[XTAB (JANUS DEFINE parameter)|XTAB]]</var> parameter of the socket.
%old = $Sock_Set(%socket, 'BINARY')
Repeat
%len = $Sock_RecvPrs(%socket, %s)
If %len Le 0 Then
Loop End
End If
%xlate = $Sock_Tran_In(%s, %socket)
Print %xlate
End Repeat
%old = $Sock_Set(%socket, 'BINARY', %old)