ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qp0zdipc.htm

249 lines
6.7 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>Delete Interprocess Communication Objects (QP0ZDIPC) 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. -->
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Feb 02 -->
<!-- This file has undergone html cleanup on 05/01/02 by JET -->
<!-- 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>Delete Interprocess Communication Objects (QP0ZDIPC) API</h2>
<div class="box" style="width: 80%;">
<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%">Delete control</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</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;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Delete Interprocess Communication Objects (QP0ZDIPC) API deletes one or
more interprocess communication (IPC) objects as specified by the delete
control parameter.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Job Authority</em></dt>
<dd>The calling thread must be the owner, must be the creator, or must have
*ALLOBJ special authority.
<p>For additional information on these authorities, see the <a href=
"../books/sc415302.pdf" target="_blank">iSeries Security Reference</a><img
src="wbpdf.gif" alt="Link to PDF"> book.</p>
</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Delete control</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information about which IPC objects to delete. For the layout of this
structure, see <a href="#HDRDELETEF">Delete Control Format</a>.</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><a name="HDRDELETEF">Delete Control Format</a></h3>
<p>The following shows the format of the delete control parameter. For detailed
descriptions of the fields in the table, see <a href="#HDRDELETED">Field
Descriptions</a>.<br>
</p>
<table border width="80%" cellpadding="5">
<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 objects to delete.</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="3" colspan="2">These fields repeat for
each object to delete.</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">IPC type</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Identifier</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRDELETED">Field Descriptions</a></h3>
<p><strong>Identifier.</strong> A unique IPC identifier that is used to specify
which IPC object is to be deleted. The identifier is obtained from calling the
APIs semget(), shmget(), msgget(), or QP0ZOLIP.</p>
<p><strong>IPC type.</strong> This value describes the type of IPC object to
delete. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Delete a semaphore set object.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Delete a shared memory object.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Delete a message queue object.</td>
</tr>
</table>
<p><strong>Number of objects to delete.</strong> The number of IPC objects in
the delete control parameter.</p>
<p><strong>Reserved.</strong> A reserved field. These characters must be set to
'00'x.</p>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</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">CPFA986 E</td>
<td align="left" valign="top">&amp;1 IPC objects deleted; &amp;2 IPC object not
deleted</td>
</tr>
<tr>
<td align="left" valign="top">CPDA981 D</td>
<td align="left" valign="top">Not authorized to delete IPC object &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPDA982 D</td>
<td align="left" valign="top">IPC object &amp;1 does not exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPDA983 D</td>
<td align="left" valign="top">IPC object &amp;1 is marked as damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPFA987 E</td>
<td align="left" valign="top">Delete control not valid.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R2
<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>