$Web DBCS: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Web_DBCS}} | {{DISPLAYTITLE:$Web_DBCS}} | ||
<span class="pageSubtitle" | <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. | |||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%rc</span> = <var>$Web_DBCS</var> ( <span class="term">dbcs-setting</span> ) | ||
< | </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> | |||
< | <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"> | |||
<tr><th><var>OFF</var></th> | |||
< | |||
< | |||
<td>Disables DBCS output translation.</td></tr> | <td>Disables DBCS output translation.</td></tr> | ||
<tr><th>ON</th> | |||
<tr><th><var>ON</var></th> | |||
<td>Enables DBCS output translation.</td></tr> | <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>Resets DBCS translation to whatever is set in the port's definition. | ||
</td></tr></table> | |||
</td></tr></table> | </td></tr></table> | ||
| Line 26: | Line 34: | ||
<tr><th>Code</th> | <tr><th>Code</th> | ||
<th>Meaning</th></tr> | <th>Meaning</th></tr> | ||
<tr><th>0</th> | <tr><th>0</th> | ||
<td>Success.</td></tr> | <td>Success.</td></tr> | ||
<tr><th>-1</th> | <tr><th>-1</th> | ||
<td>Not a Web Server thread.</td></tr> | <td>Not a Web Server thread.</td></tr> | ||
<tr><th>-2</th> | <tr><th>-2</th> | ||
<td>DBCSENV parameter is zero (DBCS support not enabled).</td></tr> | <td>DBCSENV parameter is zero (DBCS support not enabled).</td></tr> | ||
<tr><th>-3</th> | <tr><th>-3</th> | ||
<td>Invalid or missing argument.</td></tr> | <td>Invalid or missing argument.</td></tr> | ||
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:
|
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".