$Web DBCS: Difference between revisions

Latest revision as of 22:39, 5 June 2013

Modify DBCS output translation

$Web_DBCS lets you enable. disable, or reset Model 204 double byte character set support for this Janus Web Server thread.

$Web_DBCS takes one argument and returns a status code. It is a callable $function.

Syntax

%rc = $Web_DBCS ( dbcs-setting )

Syntax terms

%rc

A numeric variable to contain the method's status code. Possible values are those in "Return codes", below.

dbcs-setting

The new setting of automatic DBCS character translation, and it must be one of the following:

`OFF`	Disables DBCS output translation.
`ON`	Enables DBCS output translation.
`RESET`	Resets DBCS translation to whatever is set in the port's definition.

Return codes

Code	Meaning
0	Success.
-1	Not a Web Server thread.
-2	DBCSENV parameter is zero (DBCS support not enabled).
-3	Invalid or missing argument.

Usage notes

Use $Web_DBCS to selectively invoke DBCS translation, regardless of the port's DBCS setting. Note, however, that Janus Web Server DBCS support is only available if the Model 204 DBCSENV CCAIN parameter is set to 1. For more information about Janus Web Server DBCS support, see "DBCS Feature".

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:$Web_DBCS}}
-<span class="pageSubtitle"><section begin="desc" />Modify DBCS output translation<section end="desc" /></span>
+<span class="pageSubtitle">Modify DBCS output translation</span>
+<var>$Web_DBCS</var> lets you enable. disable, or reset <var class="product">Model 204</var> double byte character set support for this <var class="product">[[Janus Web Server]]</var> thread.
+<var>$Web_DBCS</var> takes one argument and returns a status code. It is a [[Calling_Sirius_Mods_$functions|callable]] $function.
-$Web_DBCS lets you enable. disable, or reset ''Model 204'' double byte character set support for this <var class="product">[[Janus Web Server]]</var> thread.
 ==Syntax==
-<p class="syntax"><section begin="syntax" /> %RC = $Web_DBCS ( dbcs-setting )
+<p class="syntax"><span class="term">%rc</span> = <var>$Web_DBCS</var> ( <span class="term">dbcs-setting</span> )
-<section end="syntax" /></p>
+</p>
+===Syntax terms===
+<table class="syntaxTable">
+<tr><th>%rc</th>
+<td>A numeric variable to contain the method's status code. Possible values are those in [[#Return codes|"Return codes"]], below. </td></tr>
-$Web_DBCS takes one argument and returns a status code. It is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]).
+<tr><th>dbcs-setting</th>
+<td>The new setting of automatic DBCS character translation, and it must be one of the following:
+<table class="syntaxTable">
-The $Web_DBCS argument is the new setting of automatic DBCS character translation, and it must be one of the following:
+<tr><th><var>OFF</var></th>
-<table class="syntaxTable">
-<tr><th>OFF</th>
 <td>Disables DBCS output translation.</td></tr>
-<tr><th>ON</th>
+<tr><th><var>ON</var></th>
 <td>Enables DBCS output translation.</td></tr>
-<tr><th>RESET</th>
+<tr><th><var>RESET</var></th>
 <td>Resets DBCS translation to whatever is set in the port's definition.
+</td></tr></table>
 </td></tr></table>
+===Return codes===
 <table class="syntaxTable">
 <tr><th>Code</th>
-<td>Meaning</td></tr>
+<th>Meaning</th></tr>
 <tr><th>0</th>
 <td>Success.</td></tr>
 <tr><th>-1</th>
 <td>Not a Web Server thread.</td></tr>
 <tr><th>-2</th>
 <td>DBCSENV parameter is zero (DBCS support not enabled).</td></tr>
 <tr><th>-3</th>
 <td>Invalid or missing argument.</td></tr>
 </table>
-<p class="caption">$WEB_DBCS return codes</p>
-Use $Web_DBCS to selectively invoke DBCS translation, regardless of the port's DBCS setting. Note, however, that <var class="product">[[Janus Web Server]]</var> DBCS support is only available if the ''Model 204'' DBCSENV CCAIN parameter is set to 1. For more information about <var class="product">[[Janus Web Server]]</var> DBCS support, see the ''Janus Web Server Reference Manual'' .do end . .do end
+==Usage notes==
+<ul>
+<li>Use <var>$Web_DBCS</var> to selectively invoke DBCS translation, regardless of the port's DBCS setting. Note, however, that <var class="product">Janus Web Server</var> DBCS support is only available if the <var class="product">Model 204</var> DBCSENV CCAIN parameter is set to 1. For more information about <var class="product">Janus Web Server</var> DBCS support, see [[DBCS feature|"DBCS Feature"]].
 [[Category:Janus Web Server $functions|$Web_DBCS]]