friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QTVOPNVT.htm

1295 lines
36 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Open Virtual Terminal Path (QTVOPNVT) API</title>
<!-- Begin Header Records -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- QTVOPNVT SCRIPT A converted by B2H R3.0 (300) (CMS-OS2) by -->
<!-- JSTEVENS at RCHVMX2 on 23 Feb 2001 at 14:32:18 -->
<!-- 031014 RIETH: add profile token support -->
<!-- File cleanup completed August 2001 by v2cdijab -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link-->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Open Virtual Terminal Path (QTVOPNVT) API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Virtual terminal handle</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(16)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Keyboard language type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(3)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Character set</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Code page</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Work station type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Qualified data queue name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Key value</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Length of key value</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group: 1<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">10</td>
<td align="left" valign="top" width="50%">Open operation information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group: 2<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">11</td>
<td align="left" valign="top" width="50%">Session initiation information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group: 3<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">12</td>
<td align="left" valign="top" width="50%">Open feedback information</td>
<td align="left" valign="top" width="20%">I/O</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="left" valign="top">Length of open feedback information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Open Virtual Terminal Path (QTVOPNVT) API opens a path to a virtual
terminal, allowing a server program to interact with an iSeries application.
The virtual terminal path remains open until it is explicitly closed or the job
is ended.</p>
<p>When you call the QTVOPNVT API, the operating system selects or
automatically configures a virtual terminal for you and indicates that the
device is logically turned on. The operating system sends a message to the
specified data queue to signal the server program that data is available.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Library Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Queue Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Queue Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Virtual terminal handle</strong></dt>
<dd>OUTPUT; CHAR(16)
<p>A reference code created by the iSeries operating system to identify this
open virtual terminal path in later calls to other virtual terminal APIs.</p>
</dd>
<dt><strong>Keyboard language type</strong></dt>
<dd>INPUT; CHAR(3)
<p>The keyboard language type for the virtual terminal. To use the system
value, specify blanks for this parameter. For a list of other valid values, see
the Create Device Description (CRTDEVDSP) command in the
<a href="../rbam6/rbam6clmain.htm">Control Language (CL)</a> information.
For details about supported languages, see the
<a href="../nls/rbagsglobalmain.htm">Globalization</a> topic.</p>
</dd>
<dt><strong>Character set</strong></dt>
<dd>INPUT; BINARY(4)
<p>The graphic character set for the virtual terminal. Valid values are a
specific graphic character set number and these special values:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The graphic character set system value is
used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The keyboard language type is used to select the
appropriate character set.</td>
</tr>
</table>
<p>For details about the graphic character sets you can specify, see the
<a href="../nls/rbagsglobalmain.htm">Globalization</a> topic.</p>
<p><strong>Note:</strong> The graphic character set system value is obtained
from the default graphic character set and code page (QCHRID) system value.</p>
</dd>
<dt><strong>Code page</strong></dt>
<dd>INPUT; BINARY(4)
<p>The code page for the virtual terminal. For details about the code pages you
can specify, see the <a href="../nls/rbagsglobalmain.htm">Globalization</a>
topic. If you specified 0 or -1 for the character set parameter, you do not
have to specify this parameter. When you use 0 for the character set parameter,
the system value is used for this parameter. When you use -1 for the character
set parameter, the code page value is derived from the keyboard language type
parameter.</p>
<p><strong>Note:</strong> The code page system value is obtained from the
default graphic character set and code page (QCHRID) system value.</p>
</dd>
<dt><strong>Work station type</strong></dt>
<dd>INPUT; BINARY(4)
<p>The type of work station to use. Valid values are 1 through 15. See
<a href="#HDRWSMOD">Supported Work Station Types and Models</a> for an
explanation of the values.</p>
<p>Other work station types and models are supported. You can specify these by
determining their equivalents in <a href="#TBLWSTYPE">Workstation Types and
Models</a>.</p>
<p>If a virtual terminal description does not yet exist for the work station
type specified, the operating system attempts to configure the work station
automatically. Automatic configuration is controlled by the Automatic virtual
device configuration (QAUTOVRT) system value, which specifies the number of
virtual terminals that the operating system can configure automatically. See
for more information on the QAUTOVRT value.</p>
</dd>
<dt><strong>Qualified data queue name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The name and library of the data queue used by your application program to
receive data from the operating system asynchronously. The first 10 bytes are
for the data queue name; the second 10 bytes are for the library name.
Allowable special values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The jobs current library</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Key value</strong></dt>
<dd>INPUT; CHAR(*)
<p>The key value to use for the iSeries data queue.</p>
</dd>
<dt><strong>Length of key value</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the key value. Valid values are 0 through 256. If you specify
0, no key is used for data queue entries.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3>Optional Parameter Group 1</h3>
<dl>
<dt><strong>Open operation information</strong></dt>
<dd>INPUT; CHAR(10)
<p>Information about the open operation. The characters and their meanings
are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Whether the PC text-assist function is supported.
Valid values are:
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>Blank</em></td>
<td align="left" valign="top">The PC text-assist function is supported.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PC text-assist function is supported.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PC text-assist function is not supported. The
adapted word processing function is used automatically.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>2-10</em></td>
<td align="left" valign="top">Reserved. These characters must be blank.</td>
</tr>
</table>
</dd>
</dl>
<br>
<h3><a name="#HDROPT2">Optional Parameter Group 2</a></h3>
<dl>
<dt><strong>Session initiation information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information about the initiation of the virtual terminal session. The
information must be in the following format:</p>
<dl>
<dt><em>Number of variable length records</em></dt>
<dd>The total number of all of the variable length records.</dd>
<dt><em>Variable length records</em></dt>
<dd>The attributes of the session initiation that are to be performed or
changed. For the specific format of the variable length record, see
<a href="#HDRVARLENF">Format for Variable Length Record</a>.</dd>
</dl>
</dd>
</dl>
<br>
<h3>Optional Parameter Group 3</h3>
<dl>
<dt><strong>Open feedback information</strong></dt>
<dd>I/O; CHAR(*)
<p>A pointer to information about the device assigned to this virtual terminal
session or the reason code when an automatic sign-on request fails. The layout
of this information is described in <a href="#HDRFDBK">Format for Open Feedback
Information</a>.</p>
</dd>
<dt><strong>Length of open feedback information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The size of the open feedback output area being supplied by the caller. The
Open Feedback Information returned will be restricted such that it always
returns a total number of bytes equal to or less than this parameter.</p>
</dd>
</dl>
<br>
<h3><a name="HDRVARLENF">Format for Variable Length Record</a></h3>
<p>The following table defines the format for the variable length records.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Key</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of data</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Data</td>
</tr>
</table>
<p>If the length of the data is longer than the key fields data length, the
data will be truncated at the right. No message will be issued.</p>
<p>If the length of the data is smaller than the key field s data length, the
data will be padded with blanks at the right. No message will be issued.</p>
<p>It is not an error to specify a key more than once. If duplicate keys are
specified, the last specified value for that key is used.</p>
<br>
<h3>Field Descriptions</h3>
<p><strong>Data.</strong> The data used to control the session initiation.</p>
<p><strong>Key.</strong> An attribute of the session initiation. See Keys for
the list of valid keys.</p>
<p><strong>Length of data.</strong> The length of the data used to control the
initiation.</p>
<br>
<h3><a name="HDRVLRKEYS">Keys</a></h3>
<p>The following table shows the valid keys for the key field area of the
variable length record.</p>
<table border width="80%">
<tr>
<th align="center" valign="top">Key</th>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Field</th>
</tr>
<tr>
<td align="center" valign="top" width="15%">1</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="65%">User profile</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User password</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Initial program</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Initial menu</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Current library</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Virtual device name</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Network address</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Automatic sign-on (see
<a href="#HDRSIGNKEY">Automatic Sign-on Key</a>)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">Profile Token</td>
</tr>
</table>
<br>
<br>
<h3><a name="Header_9">Field Descriptions</a></h3>
<p><strong>Automatic sign-on.</strong> The values needed to have a user
automatically signed on once a terminal session has been established. If key 8
is not specified, automatic sign-on will not occur for this virtual terminal
session; keys 3, 4, and 5 will be ignored. The automatic sign-on
must be used in place of key 1 and 2 whenever the system value QPWDLVL is set
to 2 or 3. When the system value QPWDLVL is set to 0 or 1, either keys 1 and 2
or key 8 may be used for automatic sign-on.
</p>
<p><strong>Current library.</strong> The current library to be used when using
automatic sign-on. The special value *USRPRF can be used to indicate that the
current library found in the user profile specified with key 1 should be used.
If key 5 is not specified, *USRPRF is the default. This value is supported for
both key 1 and key 8.</p>
<p><strong>Initial menu.</strong> The initial menu to be used when using
automatic sign-on. The special value *USRPRF can be used to indicate that the
initial menu found in the user profile specified with key 1 should be used.
This value is supported for both key 1 and key 8. If key 4 is not specified,
*USRPRF is the default.</p>
<p><strong>Initial program.</strong> The initial program to be used when using
automatic sign-on. The special value *USRPRF can be used to indicate that the
initial program found in the user profile specified with key 1 should be used.
If key 3 is not specified, *USRPRF is the default. This value is supported for
both key 1 and key 8.</p>
<p><strong>Network address.</strong> An address that is uniquely assigned to
each terminal session and is used in all communications with the session. This
address is associated with the virtual terminal device by the applicaion and can be
accessed by any other application using the Retrieve Device Description
(QDCRDEVD) API. The following
format defines the layout of the network address based on the network protocol:</p>
<ol>
<li>Size of network address<br>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>CHAR(1)</em></td>
<td align="left" valign="top">The number of bytes of network address actually
used. All 20 bytes allocated for the network address may not actually be
used.</td>
</tr>
</table>
<br>
</li>
<li>Family or protocol<br>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top" nowrap><em>CHAR(1)</em></td>
<td align="left" valign="top">The family or protocol that is being
used (currently, only IP is supported). The family or protocol
defines the layout used for the remainder of the network address.
<p>Internet Protocol (IP) value is X'02.'</p>
</td>
</tr>
</table>
<br>
</li>
<li>Internet Protocol (IP)<br>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>CHAR(2)</em></td>
<td align="left" valign="top">TCP port number</td>
</tr>
<tr>
<td align="left" valign="top"><em>CHAR(4)</em></td>
<td align="left" valign="top">Internet address</td>
</tr>
</table>
<br>
</li>
</ol>
<p><strong>Profile Token.</strong> A 32-byte Profile Token which may be used
as an alternative to using key 8, or keys 1 and 2 for Automatic sign-on purposes.
When key 9 is used for Automatic sign-on, keys 3, 4 and 5 will also be honored if specified.
Also, if Optional parameter group 3 is specified, the Automatic sign-on response code
can be used to determine the result of the Automatic sign-on request when using key 9.
Profile tokens may be used for all values of the system value QPWDLVL. </p>
<p><strong>User password.</strong> The user password specified for initiating
this virtual terminal session in conjunction with the specified profile. If the
user profile is *CURRENT, you can use the special value *NONE for the user
password. If you specify a user profile other than *CURRENT or blank and do not
specify a user password, an error message is returned. This value works in
association with key 1 (but not with key 8). This key is
supported only when system value QPWDLVL is set to 0 or 1.
Note that the Automatic sign-on
Reason Code value from Optional Parameter Group 3 is undefined when using keys 1
and 2 for Automatic sign-on.</p>
<p><strong>User profile.</strong> The user profile specified for initiating
this virtual terminal session. You can use the special value *CURRENT for the
user profile. If the user profile is *CURRENT, you can use the special value
*NONE for the password. This value is used in association with key 2 (but not
with key 8). If key 1 is not specified, automatic sign-on will not occur for
this virtual terminal session; keys 2, 3, 4, and 5 will be ignored.
This key is supported only when system value QPWDLVL is set to 0 or 1.
Note that the Automatitic sign-on
Reason Code value from Optional Parameter Group 3 is undefined when using keys 1
and 2 for Automatic sign-on.</p>
<p><strong>Virtual device name.</strong> The specific virtual device to be
associated with the terminal session.</p>
<p>The device is created by the system, if it does not exist, when the QAUTOVRT
system value allows for this.</p>
<p>If no value is supplied by the caller, the virtual terminal API defaults to
using the virtual device selection methods.</p>
<p>The device description name must be a valid *VRT and must adhere to standard
iSeries naming conventions.</p>
<br>
<h3><a name="HDRSIGNKEY">Automatic Sign-on Key</a></h3>
<p>The following table defines the format for the automatic sign-on key.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Sign-on length</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Passphrase CCSID</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Passphrase offset</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Passphrase length</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">F</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Client seed</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Server seed</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Bypass user profile</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Passphrase</td>
</tr>
</table>
<br>
<br>
<h3><a name="Header_11">Field Descriptions</a></h3>
<p><strong>Bypass user profile.</strong> The user profile to be automatically
signed on. This profile is not interchangeable with the user profile from key
1. If key 8 is used, then the profile must be part of the automatic sign-on
information.</p>
<p><strong>Client seed.</strong> A randomly-generated seed that was used to
encrypt the password or passphrase using the encryption level (either DES-7 or
SHA-1) on the system. If a zero-length seed is provided, it is assumed that a
clear-text unencrypted password or passphrase is being provided.</p>
<p><strong>Passphrase CCSID.</strong> The CCSID of the password or passphrase
being provided for automatic sign-on.</p>
<p><strong>Passphrase offset.</strong> The offset in this structure of the
actual password or passphrase being provided for automatic sign-on.</p>
<p><strong>Passphrase length.</strong> The number of bytes in the password or
passphrase being provided.</p>
<p><strong>Passphrase.</strong> The password or passphrase associated with the
user profile to be automatically signed on. This field can range from 1 to 128
bytes. If your system is pre-V5R1, or has system value QPWDLVL set
to 0 or 1, then the maximum size of this field is 10 bytes.</p>
<p><strong>Reserved.</strong> Reserved for future use.</p>
<p><strong>Server seed.</strong> A randomly-generated seed that was used to
encrypt the password or passphrase using the encryption level (either DES-7 or
SHA-1) on the system. If a zero-length seed is provided, it is assumed that a
clear-text unencrypted password or passphrase is being provided.</p>
<p><strong>Sign-on length.</strong> The total number of bytes of the automatic
sign-on data provided.</p>
<br>
<h3><a name="HDRFDBK">Format for Open Feedback Information</a></h3>
<p>The following table defines the format for the open feedback
information.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of bytes available
</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of bytes returned
</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reason code (see <a href="#HDRSIGNON">Automatic
Sign-on Reason Codes</a>)</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Device name</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSIGNON">Automatic Sign-on Reason Codes</a></h3>
<p>The following table shows the reason codes that may be returned for
automatic sign-on failure.
The reason code field is undefined when using keys 1 and 2 for Automatic
sign-on.</p>
<table border width="80%">
<!-- cols="10 90" -->
<tr>
<th align="center" valign="bottom">Reason<br>
Code</th>
<th align="left" valign="bottom">Failure Description</th>
</tr>
<tr>
<td align="center" valign="top" width="5%">1</td>
<td align="left" valign="top" width="95%">System error (unknown error)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">User profile unknown</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">User profile disabled</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Password or passphrase not valid</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Password or passphrase is expired</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Pre-V2R2 password</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Next password or passphrase that is not valid
will revoke user profile</td>
</tr>
<tr>
<td align="center" valign="top">9
</td>
<td align="left" valign="top">Profile Token invalid or expired
</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Device Name.</strong> The device name that has actually been assigned
to this terminal session.</p>
<p><strong>Number of bytes available.</strong> The total number of bytes of
feedback information available for return.
This space is provided by the caller.</p>
<p><strong>Number of bytes returned.</strong> The total number of bytes of
feedback information actually returned to the caller. </p>
<p><strong>Reason code.</strong> Reason an automatic sign-on request has
failed. For possible reason code values, see <a href="#HDRSIGNON">Automatic
Sign-on Reason Codes</a>.</p>
<p><strong>Reserved.</strong> Reserved for future use.</p>
<br>
<h3><a name="HDRWSMOD">Supported Work Station Types and Models</a></h3>
<p>The following table details the values you can specify for the QTVOPNVT
APIs work station type parameter.</p>
<table border width="100%">
<tr>
<th align="left" colspan="4"><em><a name="TBLWSTYPE">Workstation Types and
Models</a></em></th>
</tr>
<tr>
<th align="center" valign="bottom">Value</th>
<th align="left" valign="bottom">Work Station Type and Model</th>
<th align="left" valign="bottom">Equivalent Type and Model</th>
<th align="left" valign="bottom">Description</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="15%">5251-11</td>
<td align="left" valign="top" width="15%"><br>
</td>
<td align="left" valign="top" width="60%">24 x 80 monochrome display.</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">5291-1</td>
<td align="left" valign="top">5291-2</td>
<td align="left" valign="top">24 x 80 monochrome display.</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">5292-2</td>
<td align="left" valign="top"><br>
</td>
<td align="left" valign="top">24 x 80 color graphics display. This type is also
emulated by a graphics work station feature.</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">5555-B01</td>
<td align="left" valign="top">5555-E01</td>
<td align="left" valign="top">24 x 80 monochrome double-byte character set
(DBCS) display. This type is emulated by a monochrome work station feature that
supports a DBCS display.</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">3196-A1</td>
<td align="left" valign="top">3196-A2<br>
3196-B1<br>
3196-B2<br>
3476-EA</td>
<td align="left" valign="top">24 x 80 monochrome display. This type is emulated
by a monochrome work station feature. This is what the ASCII devices
emulate.</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">3179-2</td>
<td align="left" valign="top">3197-C1<br>
3197-C2<br>
3476-EC<br>
5292-1</td>
<td align="left" valign="top">24 x 80 color display. This type is emulated by a
color work station feature.</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">3180-2</td>
<td align="left" valign="top">3197-D1<br>
3197-D2<br>
3197-W1<br>
3197-W2</td>
<td align="left" valign="top">27 x 132 monochrome display.</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">3477-FC</td>
<td align="left" valign="top"><br>
</td>
<td align="left" valign="top">27 x 132 wide-screen color display.</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">3477-FG</td>
<td align="left" valign="top">3477-FA<br>
3477-FD<br>
3477-FE<br>
3477-FW</td>
<td align="left" valign="top">27 x 132 wide-screen monochrome display.</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="left" valign="top">5555-C01</td>
<td align="left" valign="top">5555-F01</td>
<td align="left" valign="top">24 x 80 color double-byte character set (DBCS)
display. This type is emulated by a color work station feature that supports a
DBCS display.</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="left" valign="top">5555-G01</td>
<td align="left" valign="top"><br>
</td>
<td align="left" valign="top">24 x 80 double-byte character set (DBCS)
monochrome graphics display. This type is emulated by a monochrome work station
feature that supports a DBCS display.</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="left" valign="top">5555-G02</td>
<td align="left" valign="top"><br>
</td>
<td align="left" valign="top">24 x 80 color double-byte character set (DBCS)
graphics display. This type is emulated by a color graphics work station
feature that supports a DBCS display.</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="left" valign="top">3486-BA</td>
<td align="left" valign="top"><br>
</td>
<td align="left" valign="top">24 x 80 monochrome display.</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="left" valign="top">3487-HA</td>
<td align="left" valign="top">3487-HG<br>
3487-HW</td>
<td align="left" valign="top">24 x 80 or 27 x 132 monochrome display.</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="left" valign="top">3487-HC</td>
<td align="left" valign="top"><br>
</td>
<td align="left" valign="top">24 x 80 or 27 x 132 color display.</td>
</tr>
</table>
<br>
<br>
<h3>Usage Notes</h3>
<ol>
<li>All 5250 work stations, except 5555 Model B01, can operate as 5251 Model 11
work stations.<br>
<br>
</li>
<li>Selecting double-byte character set (DBCS) work stations requires the
iSeries primary language to be one of the DBCS national language versions
(NLVs).</li>
</ol>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top" width="15%">CPF1842 E</td>
<td align="left" valign="top" width="85%">Cannot access system value
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C4D E</td>
<td align="left" valign="top">Length &amp;1 for key &amp;2 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C81 E</td>
<td align="left" valign="top">Value for key &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C82 E</td>
<td align="left" valign="top">Key &amp;1 not valid for API &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C84 E</td>
<td align="left" valign="top">Key &amp;1 required with value specified for key
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C86 E</td>
<td align="left" valign="top">Required key &amp;1 not specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C88 E</td>
<td align="left" valign="top">Number of variable length records &amp;1 is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87D7 E</td>
<td align="left" valign="top">Cannot automatically select virtual device.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87FA E</td>
<td align="left" valign="top">Character identifier not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87FB E</td>
<td align="left" valign="top">Cannot exceed maximum number of active Virtual
Terminal sessions.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87F0 E</td>
<td align="left" valign="top">Virtual terminal type value &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87F1 E</td>
<td align="left" valign="top">Queue key length &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87F2 E</td>
<td align="left" valign="top">Virtual terminal handle &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87F7 E</td>
<td align="left" valign="top">Parameter value &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87F8 E</td>
<td align="left" valign="top">Unexpected internal system error occurred in
program &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF87F9 E</td>
<td align="left" valign="top">Keyboard language type &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E18 E</td>
<td align="left" valign="top">Attempt made to exceed usage limit for product
&amp;1. User not added.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E71 E</td>
<td align="left" valign="top">Grace period expired. Requesting user not
added.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E73 E</td>
<td align="left" valign="top">Expiration date &amp;4 was reached.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E78 E</td>
<td align="left" valign="top">The license key for product &amp;1, license term
&amp;2, feature &amp;3 is no longer valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="vt1a.htm">Virtual Terminal APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue Copy Permalink