245 lines
7.3 KiB
HTML
245 lines
7.3 KiB
HTML
<!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>Suspend or Restore Display File (QWSSPRST) 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. -->
|
|
<!-- QWSSPRST SCR450 A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
|
|
<!-- at RCHVMW2 on 1 Oct 1999 at 16:10:01 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- File cleanup completed 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>Suspend or Restore Display File (QWSSPRST) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
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%">Function requested</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Handle to suspended file</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Screen image option</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Suspend or Restore Display File (QWSSPRST) API gives the caller the
|
|
ability to either suspend the active display file on the requester device or
|
|
restore a suspended file to the requester device. The suspend function returns
|
|
a handle to the suspended file. The restore function accepts a handle of a
|
|
suspended file to be restored.</p>
|
|
|
|
<p>The QWSSPRST API also allows the caller to have the screen image saved
|
|
before the file is suspended. When the file is restored, this screen image also
|
|
can be restored.</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Function requested</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The function requested for the start of QWSSPRST. The following functions
|
|
can be specified:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Suspend the active file on the requester device
|
|
and return a corresponding handle to that file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Restore a suspended file to the requester device.
|
|
The handle indicates which file will be restored.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Handle to suspended file</strong></dt>
|
|
|
|
<dd>I/O; BINARY(4)
|
|
|
|
<p>When suspending the active file (function 0), a handle to the suspended file
|
|
will be returned in this parameter. When restoring a suspended file (function
|
|
1), this parameter accepts the handle of the file to be restored.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Screen image option</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>When suspending the active file (function 0), this parameter gives the
|
|
caller the option to save the current screen image. When restoring a suspended
|
|
file (function 1), this parameter gives the caller the option to restore the
|
|
saved screen image associated with the suspended file. If there is no saved
|
|
screen image associated with the suspended file, this parameter is ignored when
|
|
doing a restore.</p>
|
|
|
|
<p>If the screen image is not saved and restored when the file is restored, it
|
|
is assumed that the application that is using the file will redraw the screen
|
|
image. The following options can be specified:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">If suspending the active file (function 0), do
|
|
not save the screen image. If restoring an active file (function 1), do not
|
|
restore the screen image associated with the suspended file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">If suspending the active file (function 0), save
|
|
the current screen image. If restoring an active file (function 1), restore the
|
|
screen image associated with the suspended file.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This parameter provides a function similar to that of the RSTDSP parameter
|
|
of the CRTDSPF and CHGDSPF commands. Be aware that the command parameter causes
|
|
the system to save and restore the screen image if RSTDSP(*YES) is used. The
|
|
user of this API must request save the screen image at suspend time and restore
|
|
the screen image at restore time to have the same function.</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>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<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%">CPF24B4 E</td>
|
|
<td align="left" valign="top" width="85%">Severe error while addressing
|
|
parameter list.</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">CPF3C36 E</td>
|
|
<td align="left" valign="top">Number of parameters, &1, entered for this
|
|
API was 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">CPF4738 E</td>
|
|
<td align="left" valign="top">Parameter value not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF5082 E</td>
|
|
<td align="left" valign="top">Suspend request failed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF5083 E</td>
|
|
<td align="left" valign="top">Restore request failed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V4R5
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center">
|
|
<a href="#Top">Top</a> |
|
|
<a href="wss1.htm">Work Station Support APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|