$Web DBCS: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 4: Line 4:
<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> 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 callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]).  
<var>$Web_DBCS</var> takes one argument and returns a status code. It is a [[Calling_Sirius_Mods_$functions|callable]] $function.  


==Syntax==
==Syntax==
Line 13: Line 13:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%rc</th>
<tr><th>%rc</th>
<td>A numeric variable to contain the method's return value. Possible values are those in [[#Return codes|"Return codes"]], below. </td></tr>
<td>A numeric variable to contain the method's status code. Possible values are those in [[#Return codes|"Return codes"]], below. </td></tr>
<tr><th>dbcs-setting</th>
<tr><th>dbcs-setting</th>
<td>The new setting of automatic DBCS character translation, and it must be one of the following:
<td>The new setting of automatic DBCS character translation, and it must be one of the following:

Revision as of 20:49, 16 June 2012

<section begin="desc" />Modify DBCS output translation<section end="desc" />

$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

<section begin="syntax" />%rc = $Web_DBCS ( dbcs-setting ) <section end="syntax" />

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".