<?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_GetKey" /> <meta name="DC.Relation" scheme="URI" content="rzaikdqapilist4.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_getkey" /> <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_GetKey</title> </head> <body id="cwbdq_getkey"><a name="cwbdq_getkey"><!-- --></a> <!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script> <h1 class="topictitle1"><span class="apiname">cwbDQ_GetKey</span></h1> <div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Get the key attribute of the data object, previously set by the <span class="apiname">cwbDQ_SetKey</span> API. This is the key that is used for writing data to a keyed data queue. Along with the search order, this key is also used to read data from a keyed data queue. The key that is associated with the record retrieved can be obtained by calling the <span class="apiname">cwbDQ_GetRetKey</span> API.</p> </div> <div class="section"><h4 class="sectiontitle">Syntax</h4><pre> unsigned int CWB_ENTRY cwbDQ_GetKey( cwbDQ_Data data, unsigned char *key);</pre> </div> <div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbDQ_Data data - input</dt> <dd>Handle of the data object that was returned by a previous call to <span class="apiname">cwbDQ_CreateData</span>.</dd> <dt class="dlterm">unsigned char * key - output</dt> <dd>Pointer to the key. The key may contain embedded NULLS, so it is not an ASCIIZ string.</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_DATA_HANDLE</dt> <dd>Invalid data 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="rzaikdqapilist4.htm" title="Use these APIs for writing to and reading from a data queue">Data Queues: Read and write APIs</a></div> </div> </div> </body> </html>