73 lines
3.8 KiB
HTML
73 lines
3.8 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_GetOrder" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikdqapilist3.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_getorder" />
|
|
<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_GetOrder</title>
|
|
</head>
|
|
<body id="cwbdq_getorder"><a name="cwbdq_getorder"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">cwbDQ_GetOrder</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Get the attribute for the queue order. If
|
|
the order is CWBDQ_SEQ_LIFO, the last record written is the first record read
|
|
(Last In First Out). If the order is CWBDQ_SEQ_FIFO, the first record written
|
|
is the first record read (First In First Out). If the order is CWBDQ_SEQ_KEYED,
|
|
the order in which records are read from the data queue depends on the value
|
|
of the search order attribute of the data object and the key value specified
|
|
for the <span class="apiname">cwbDQ_SetKey</span> API. If multiple records contain the
|
|
key that satisfies the search order, a FIFO scheme is used among those records.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY cwbDQ_GetOrder(
|
|
cwbDQ_Attr queueAttributes,
|
|
unsigned short *order);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbDQ_Attr queueAttributes - input</dt>
|
|
<dd>Handle of the data queue attributes returned by a previous call to <span class="apiname">cwbDQ_CreateAttr</span>.</dd>
|
|
<dt class="dlterm">unsigned short * order - output</dt>
|
|
<dd>Pointer to an unsigned short where the order will be written. Possible
|
|
values are: <ul><li>CWBDQ_SEQ_LIFO</li>
|
|
<li>CWBDQ_SEQ_FIFO</li>
|
|
<li>CWBDQ_SEQ_KEYED</li>
|
|
</ul>
|
|
</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_INVALID_POINTER</dt>
|
|
<dd>Bad or null pointer.</dd>
|
|
<dt class="dlterm">CWBDQ_INVALID_ATTRIBUTE_HANDLE</dt>
|
|
<dd>Invalid attributes handle.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>None</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikdqapilist3.htm" title="Use these APIs to declare attributes of a data queue. The attribute object is used when creating a data queue or when obtaining the data queue attributes.">Data Queues: Attributes APIs</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |