121 lines
5.9 KiB
HTML
121 lines
5.9 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="cwbDQ_OpenEx" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikdqapilist1.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="cwbdq_openex" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>cwbDQ_OpenEx</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbdq_openex"><a name="cwbdq_openex"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbDQ_OpenEx</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Start a connection to the specified data
|
||
|
|
queue. This will start a conversation with the iSeries™ system. If the connection is
|
||
|
|
not successful, a non-zero handle will be returned.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbDQ_OpenEx(
|
||
|
|
cwbCO_SysHandle sysHandle
|
||
|
|
const char *queue,
|
||
|
|
const char *library,
|
||
|
|
cwbDQ_QueueHandle *queueHandle,
|
||
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle sysHandle - input</dt>
|
||
|
|
<dd>Handle to a system object.</dd>
|
||
|
|
<dt class="dlterm">const char * queue - input</dt>
|
||
|
|
<dd>Pointer to the data queue name contained in an ASCIIZ string.</dd>
|
||
|
|
<dt class="dlterm">const char * library - input</dt>
|
||
|
|
<dd>Pointer to the library name that is contained in an ASCIIZ string. If
|
||
|
|
this pointer is NULL, the library list will be used (set library to "*LIBL").</dd>
|
||
|
|
<dt class="dlterm">cwbDQ_QueueHandle * queueHandle - output</dt>
|
||
|
|
<dd>Pointer to a cwbDQ_QueueHandle where the handle will be returned. This
|
||
|
|
handle should be used in all subsequent calls.</dd>
|
||
|
|
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
|
||
|
|
<dd>Any returned messages will be written to this object. It is created with
|
||
|
|
the <span class="apiname">cwbSV_CreateErrHandle</span> API. The messages may be retrieved
|
||
|
|
through the <span class="apiname">cwbSV_GetErrText</span> API. If the parameter is set
|
||
|
|
to zero, no messages will be retrieved.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
|
||
|
|
values.</p>
|
||
|
|
<dl><dt class="dlterm">CWB_OK</dt>
|
||
|
|
<dd>Successful completion.</dd>
|
||
|
|
<dt class="dlterm">CWB_COMMUNICATIONS_ERROR</dt>
|
||
|
|
<dd>A communications error occurred.</dd>
|
||
|
|
<dt class="dlterm">CWB_SERVER_PROGRAM_NOT_FOUND</dt>
|
||
|
|
<dd>iSeries application
|
||
|
|
not found.</dd>
|
||
|
|
<dt class="dlterm">CWB_HOST_NOT_FOUND</dt>
|
||
|
|
<dd>iSeries system
|
||
|
|
inactive or does not exist.</dd>
|
||
|
|
<dt class="dlterm">CWB_COMM_VERSION_ERROR</dt>
|
||
|
|
<dd>Data Queues will not run with this version of communications.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_POINTER</dt>
|
||
|
|
<dd>Bad or null pointer.</dd>
|
||
|
|
<dt class="dlterm">CWB_SECURITY_ERROR</dt>
|
||
|
|
<dd>A security error has occurred.</dd>
|
||
|
|
<dt class="dlterm">CWB_LICENSE_ERROR</dt>
|
||
|
|
<dd>A license error has occurred.</dd>
|
||
|
|
<dt class="dlterm">CWB_CONFIG_ERROR</dt>
|
||
|
|
<dd>A configuration error has occurred.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_BAD_QUEUE_NAME</dt>
|
||
|
|
<dd>Queue name is too long.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_BAD_LIBRARY_NAME</dt>
|
||
|
|
<dd>Library name is too long.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_BAD_SYSTEM_NAME</dt>
|
||
|
|
<dd>System name is too long.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_REJECTED_USER_EXIT</dt>
|
||
|
|
<dd>Command rejected by user exit program.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_USER_EXIT_ERROR</dt>
|
||
|
|
<dd>Error in user exit program.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_LIBRARY_NOT_FOUND</dt>
|
||
|
|
<dd>Library not found on system.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_QUEUE_NOT_FOUND</dt>
|
||
|
|
<dd>Queue not found on system.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_NO_AUTHORITY</dt>
|
||
|
|
<dd>No authority to queue or library.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_DAMAGED_QUE</dt>
|
||
|
|
<dd>Queue is in unusable state.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_CANNOT_CONVERT</dt>
|
||
|
|
<dd>Data cannot be converted for this queue.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input Unicode characters have no representation in the code
|
||
|
|
page being used.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
|
||
|
|
<dd>Invalid system handle.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This function requires that you previously
|
||
|
|
have issued <span class="apiname">cwbCO_CreateSystem</span>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikdqapilist1.htm" title="Use these APIs in conjunction with the cwbCO_SysHandle System Object handle.">Data Queues: Create, delete, and open APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|