229 lines
5.0 KiB
HTML
229 lines
5.0 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>gsk_environment_close()--Close an SSL environment</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: -->
|
||
|
|
<!-- Created for V5R1 -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<!--Java sync-link-->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2>gsk_environment_close()--Close an SSL environment</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
<p> Syntax</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <gskssl.h>
|
||
|
|
|
||
|
|
int gsk_environment_close(gsk_handle *<em>my_env_handle</em>);
|
||
|
|
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
Service Program Name: QSYS/QSOSSLSR<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>gsk_environment_close()</strong> function is used to close the
|
||
|
|
SSL environment and release all storage associated with the environment.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>my_env_handle</strong> (Input) </dt>
|
||
|
|
|
||
|
|
<dd>A pointer to the handle for the SSL environment to be closed.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities</h3>
|
||
|
|
|
||
|
|
<p>No authorization is required.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<p><strong>gsk_environment_close()</strong> returns an integer. Possible values
|
||
|
|
are:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>[GSK_OK]</em></dt>
|
||
|
|
|
||
|
|
<dd><p><strong>gsk_environment_close()</strong> was successful.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[GSK_CLOSE_FAILED]</em></dt>
|
||
|
|
|
||
|
|
<dd><p>An error occurred during close processing.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[GSK_INVALID_HANDLE]</em></dt>
|
||
|
|
|
||
|
|
<dd><p>The handle specified was not valid.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[GSK_AS400_ERROR_INVALID_POINTER]</em></dt>
|
||
|
|
|
||
|
|
<dd><p><em>my_env_handle</em> pointer is not valid.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[GSK_ERROR_IO]</em></dt>
|
||
|
|
|
||
|
|
<dd><p>An error occurred in SSL processing, check the <em>errno</em> value.</p></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Conditions</h3>
|
||
|
|
|
||
|
|
<p>When the <strong>gsk_environment_close()</strong> API fails with return code
|
||
|
|
[GSK_ERROR_IO], <em>errno</em> can be set to:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>[EINTR]</em></dt>
|
||
|
|
|
||
|
|
<dd>Interrupted function call.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[EDEADLK]</em></dt>
|
||
|
|
|
||
|
|
<dd>Resource deadlock avoided.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>[ETERM]</em></dt>
|
||
|
|
|
||
|
|
<dd>Operation terminated.</p></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>If an <em>errno</em> is returned that is not in this list, look in <a href=
|
||
|
|
"unix14.htm">Errno Values for UNIX-Type Functions</a> for a description of the
|
||
|
|
<em>errno</em>.</p>
|
||
|
|
|
||
|
|
<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 width="15%" valign="top">CPE3418 E</td>
|
||
|
|
<td width="85%" valign="top">Possible APAR condition or hardware failure.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFA081 E</td>
|
||
|
|
<td valign="top">Unable to set return value or error code.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>You should close all secure sessions using the SSL environment prior to
|
||
|
|
doing the <strong>gsk_environment_close().</strong><br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>If <strong>gsk_environment_close()</strong> is issued prior to all secure
|
||
|
|
sessions being closed, the active secure sessions will continue to work. The
|
||
|
|
resources for the SSL environment will not be freed up until after the last
|
||
|
|
secure session closes. No new secure sessions will be allowed to start using
|
||
|
|
the closed SSL environment.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="gsk_environment_init.htm">gsk_environment_init()</a>--Initialize an
|
||
|
|
SSL environment<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="gsk_environment_open.htm">gsk_environment_open()</a>--Get a handle for
|
||
|
|
an SSL environment<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="gsk_secure_soc_close.htm">gsk_secure_soc_close()</a>--Close a secure
|
||
|
|
session<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="gsk_secure_soc_init.htm">gsk_secure_soc_init()</a>--Negotiate a secure
|
||
|
|
session<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="gsk_secure_soc_open.htm">gsk_secure_soc_open()</a>--Get a handle for a
|
||
|
|
secure session<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="gsk_strerror.htm">gsk_strerror()</a>--Retrieve GSK runtime error
|
||
|
|
message</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a> </td>
|
||
|
|
</tr>
|
||
|
|
</table></center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|