81 lines
4.3 KiB
HTML
81 lines
4.3 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_Clear" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikdqapilist2.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_clear" />
|
||
|
|
<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_Clear</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbdq_clear"><a name="cwbdq_clear"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbDQ_Clear</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Remove all messages from the iSeries™ data
|
||
|
|
queue object that is identified by the specified handle. If the queue is keyed,
|
||
|
|
messages for a particular key may be removed by specifying the key and key
|
||
|
|
length. These values should be set to NULL and zero, respectively, if you
|
||
|
|
want to clear all messages from the queue.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbDQ_Clear(
|
||
|
|
cwbDQ_QueueHandle queueHandle,
|
||
|
|
unsigned char *key,
|
||
|
|
unsigned short keyLength,
|
||
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbDQ_QueueHandle queueHandle - input</dt>
|
||
|
|
<dd>Handle that was returned by a previous call to the <span class="apiname">cwbDQ_Open</span> function.
|
||
|
|
This identifies the iSeries data queue object.</dd>
|
||
|
|
<dt class="dlterm">unsigned char * key - input</dt>
|
||
|
|
<dd>Pointer to the key. The key may contain embedded NULLs, so it is not an
|
||
|
|
ASCIIZ string.</dd>
|
||
|
|
<dt class="dlterm">unsigned short keyLength - input</dt>
|
||
|
|
<dd>Length of the key in bytes.</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">CWBDQ_INVALID_QUEUE_HANDLE</dt>
|
||
|
|
<dd>Invalid queue handle.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_BAD_KEY_LENGTH</dt>
|
||
|
|
<dd>Length of key is not correct.</dd>
|
||
|
|
<dt class="dlterm">CWBDQ_REJECTED_USER_EXIT</dt>
|
||
|
|
<dd>Command rejected by user exit program.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This function requires that you have previously
|
||
|
|
issued: </p>
|
||
|
|
<ul><li><span class="apiname">cwbDQ_Open</span> or <span class="apiname">cwbDQ_OpenEx</span></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikdqapilist2.htm" title="After the cwbDQ_Open API is used to create a connection to a specific data queue, these other APIs can be used to utilize it. Use the cwbDQ_Close API when the connection no longer is needed.">Data Queues: Accessing data queues APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|