ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbdqsetdataaddr.htm

71 lines
3.6 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?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_SetDataAddr" />
<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_setdataaddr" />
<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_SetDataAddr</title>
</head>
<body id="cwbdq_setdataaddr"><a name="cwbdq_setdataaddr"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbDQ_SetDataAddr</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Set the data and data length attributes
of the data object. The default is to have no data with zero length. This
function will not copy the data.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbDQ_SetDataAddr(
cwbDQ_Data data,
unsigned char *dataBuffer,
unsigned long dataLength);</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 * dataBuffer - input</dt>
<dd>Pointer to the data. The data may contain embedded NULLS, so it is not
an ASCIIZ string.</dd>
<dt class="dlterm">unsigned long dataLength - input</dt>
<dd>Length of the data in bytes.</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>
<dt class="dlterm">CWBDQ_BAD_DATA_LENGTH</dt>
<dd>Length of data is not correct.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This function is better for large
amounts of data, or if you want to manage memory in your application. Data
will not be copied so performance will be improved.</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>