309 lines
11 KiB
HTML
309 lines
11 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>eimDestroyHandle()--Destroy an EIM Handle</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 -->
|
||
|
|
<!-- Created by Carol Budnik on 17 July 2001 -->
|
||
|
|
<!-- Edited by Kersten Jan 02 -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!--Java sync-link-->
|
||
|
|
<script type="text/javascript" language="javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
<h2>eimDestroyHandle()--Destroy an
|
||
|
|
EIM Handle</h2>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- S Y N T A X / P A R M T A B L E -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Syntax
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <eim.h>
|
||
|
|
|
||
|
|
int eimDestroyHandle(EimHandle * <em>eim</em>,
|
||
|
|
EimRC * <em>eimrc</em>)
|
||
|
|
|
||
|
|
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
Service Program Name: QSYS/QSYEIM<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- D E S C R I P T I O N -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<p>The <strong>eimDestroyHandle()</strong> function is used to deallocate an
|
||
|
|
EimHandle structure. This will close any EIM connections for this handle.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- A U T H O R I T I E S A N D L O C K S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- P A R A M E T E R S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
||
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<!-- Use this if there are no authorities and locks. -->
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl><!-- ============================================================== -->
|
||
|
|
<!-- eim -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>eim</strong> (Input)</dt>
|
||
|
|
|
||
|
|
<dd>The EIM handle returned by a previous call to eimCreateHandle().<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- eimrc -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>eimrc</strong> (Input/Output)</dt>
|
||
|
|
|
||
|
|
<dd>The structure in which to return error code information. If the return
|
||
|
|
value is not 0, eimrc is set with additional information. This parameter may be
|
||
|
|
NULL. For the format of the structure, see <a href="eimrc.htm">EimRC--EIM
|
||
|
|
Return Code Parameter</a>.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- R E T U R N V A L U E -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<p>The return value from the API. Following each return value is the list of
|
||
|
|
possible values for the <samp>messageCatalogMessageID</samp> field in the
|
||
|
|
<em>eimrc</em> parameter for that value.</p>
|
||
|
|
|
||
|
|
<dl><!-- ============================================================== -->
|
||
|
|
<!-- 0 -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>0</strong></dt>
|
||
|
|
|
||
|
|
<dd>Request was successful.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- EBADDATA -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>EBADDATA</strong></dt>
|
||
|
|
|
||
|
|
<dd>eimrc is not valid.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- EBUSY -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>EBUSY</strong></dt>
|
||
|
|
|
||
|
|
<dd>Unable to allocate internal system object.<br>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="25 75" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_NOLOCK (26)</em></td>
|
||
|
|
<td align="left" valign="top">Unable to allocate internal system object.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- EINVAL -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>EINVAL</strong></dt>
|
||
|
|
|
||
|
|
<dd>Input parameter was not valid.<br>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="35 65" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_HANDLE_INVAL (17)</em></td>
|
||
|
|
<td align="left" valign="top">EimHandle is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_PARM_REQ (34)</em></td>
|
||
|
|
<td align="left" valign="top">Missing required parameter. Please check API
|
||
|
|
documentation.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_PTR_INVAL (35)</em></td>
|
||
|
|
<td align="left" valign="top">Pointer parameter is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- EUNKNOWN -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<dt><strong>EUNKNOWN</strong></dt>
|
||
|
|
|
||
|
|
<dd>Unexpected exception.<br>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="25 75" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EIMERR_UNKNOWN (44)</em></td>
|
||
|
|
<td align="left" valign="top">Unknown error or unknown system state.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- U S A G E N O T E S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- R E L A T E D I N F O R M A T I O N -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="eimcreatehandle.htm">eimCreateHandle()</a>--Create an EIM
|
||
|
|
Handle<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimgetattribute.htm">eimGetAttribute()</a>--Get EIM Attributes<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimsetattribute.htm">eimSetAttribute()</a>--Set EIM Attributes<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimconnecttomaster.htm">eimConnectToMaster()</a>--Connect to EIM
|
||
|
|
Master Domain<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="eimconnect.htm">eimConnect()</a>--Connect to EIM Domain<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- E X A M P L E -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
<h3>Example</h3>
|
||
|
|
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
|
||
|
|
for information pertaining to code examples.</p>
|
||
|
|
<p>The following example destroys an EIM handle.</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <eim.h>
|
||
|
|
|
||
|
|
int main(int argc, char *argv[])
|
||
|
|
{
|
||
|
|
int rc;
|
||
|
|
char eimerr[100];
|
||
|
|
EimRC * err;
|
||
|
|
EimHandle * handle;
|
||
|
|
|
||
|
|
|
||
|
|
<em>/* Get eim handle from input arg. */</em>
|
||
|
|
handle = (EimHandle *)argv[1];
|
||
|
|
|
||
|
|
<em>/* Set up error structure. */</em>
|
||
|
|
memset(eimerr,0x00,100);
|
||
|
|
err = (EimRC *)eimerr;
|
||
|
|
err->memoryProvidedByCaller = 100;
|
||
|
|
|
||
|
|
<em>/* Destroy the handle */</em>
|
||
|
|
if (0 != (rc = eimDestroyHandle(handle,
|
||
|
|
err)))
|
||
|
|
printf("Destroy handle error = %d", rc);
|
||
|
|
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- F O O T E R -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R2
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|