TranIn (Socket function) - Revision history

JAL2: /* Example */

2012-06-11T19:28:23Z

Example

← Older revision		Revision as of 19:28, 11 June 2012
Line 37:		Line 37:
	</ul>		</ul>

	==~~Example~~==		==Examples==

	In the following example, parsed but not translated lines are received into the		In the following example, parsed but not translated lines are received into the
	<code>%s</code> variable, then translated, and printed in EBCDIC.		<code>%s</code> variable, then translated, and printed in EBCDIC.

JAL2: /* Syntax terms */

2011-11-15T02:06:34Z

Syntax terms

← Older revision		Revision as of 02:06, 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 local character set.		</th><td>String that is to contain the translation of the input string into the local 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 local character set.		</th><td>String that is to contain the translation of the input string into the local 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:19, 14 November 2011

2011-11-14T23:19:54Z

← Older revision		Revision as of 23:19, 14 November 2011
Line 1:		Line 1:
			{{Template:Socket:TranIn subtitle}}
	~~<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>~~
	~~[[Category~~:Socket ~~methods\|TranIn function]]~~
	~~<p>~~
	~~<var>~~TranIn~~</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~~:TranIn~~(string)~~		{{Template:Socket:TranIn syntax}}
	~~</p>~~
			===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%str		<tr><th>%str
Line 58:		Line 54:
	%old = %sock:Set('BINARY', %old)		%old = %sock:Set('BINARY', %old)
	</p>		</p>

			{{Template:Socket:TranIn 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 "
TranIn function
`TranIn` is a member of the `[[So..."`

2011-11-08T19:34:04Z

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

New page

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

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

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

==Usage notes==
<ul>
<li>The translate table <var>TranIn</var> uses is the input table
defined by the <var>[[XTAB]]</var> parameter of the socket.
<li>The <var>TranIn</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>TranIn</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>TranIn</var> 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 but not translated lines are received into the
<code>%s</code> variable, then translated, and printed in EBCDIC.
<p class="code">%sock is Object <var>Socket</var>
%sock = New
%old = %sock:Set('BINARY')
Repeat
%len = %sock:ReceiveAndParse(%s)
If %len le 0 Then
Loop End
End If
%xlate = %sock:TranIn(%s)
Print %xlate
End Repeat
%old = %sock:Set('BINARY', %old)
</p>