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

178 lines
4.4 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>QsoCreateIOCompletionPort()--Create I/O Completion Port</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 for V5R1 -->
<!-- Edited by Kersten Feb 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>QsoCreateIOCompletionPort()--Create I/O Completion Port</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;qsoasync.h&gt;
int QsoCreateIOCompletionPort()
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QSOSRV3<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The QsoCreateIOCompletionPort is used to create a common wait point for a
completed overlapped I/O operation. The wait point is represented by the I/O
completion port handle returned by the QsoCreateIOCompletionPort() function.
This handle is specified on QsoStartRecv and QsoStartSend functions to initiate
overlapped I/O operations.</p>
<br>
<h3>Authorities</h3>
<p>No authorization is required.</p>
<br>
<h3>Return Values</h3>
<p><em>QsoCreateIOCompletionPort()</em> returns an integer. Possible values are:</p>
<ul>
<li>-1 - Unsuccessful, errno is set to a value defined below.</li>
<li>n - Successful, where n is an I/O completion port handle that can be used
in conjunction with overlapped I/O functions QsoStartRecv(), QsoStartSend(),
and QsoPostIOCompletionPort().</li>
</ul>
<br>
<h3>Errno Conditions</h3>
<p>When QsoCreateIOCompletionPort() fails, errno can be set to one of the
following:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">[ENOBUFS]</td>
<td align="left" valign="top">The limit of 256 I/O completion ports has been
exceeded for this process.<br>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top">[EUNKNOWN]</td>
<td align="left" valign="top">Unknown system state.</td>
</tr>
</table>
<br>
<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 width="15%" valign="top">CPE3418 E</td>
<td width="85%" valign="top">Possible APAR condition or hardware failure.</td>
</tr>
<tr>
<td align="left" valign="top">CPFA081 E</td>
<td align="left" valign="top">Unable to set return value or error code.</td>
</tr>
</table>
<br>
<br>
<h3>Usage Notes</h3>
<ol>
<li>The I/O completion port handle is a process scoped resource; therefore, you
may not start an overlapped I/O function on a socket in one process and check
for its completion in another process.<br>
<br>
</li>
<li>The number of I/O completion ports that can be active for a given process
is 256.</li>
</ol>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="destroyiocompletionport.htm">QsoDestroyIOCompletionPort()</a>--Create
I/O Completion Port<br><br></li>
<li><a href="postiocompletion.htm">QsoPostIOCompletionPort()</a>--Post Request on
I/O Completion Port<br><br></li>
<li><a href="startrecv.htm">QsoStartRecv</a>--Start Asynchronous Recv
Operation<br><br></li>
<li><a href="startsend.htm">QsoStartSend</a>--Start Asynchronous Send
Operation<br><br></li>
<li><a href="waitforiocompletion.htm">QsoWaitForIOCompletion()</a>--Wait for I/O
Completion Operation</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>