73 lines
4.2 KiB
HTML
73 lines
4.2 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="cwbUP_GetDescription" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikufapilist5.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="cwbup_getdescription" />
|
|
<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>cwbUP_GetDescription</title>
|
|
</head>
|
|
<body id="cwbup_getdescription"><a name="cwbup_getdescription"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">cwbUP_GetDescription</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Gets the description of the update entry.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY cwbUP_GetDescription(
|
|
cwbUP_EntryHandle entryHandle,
|
|
char *entryDescription,
|
|
unsigned long bufferLength,
|
|
unsigned long *actualLength);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbUP_EntryHandle entryHandle - input</dt>
|
|
<dd>Handle that was returned by a previous call to <span class="apiname">cwbUP_CreateUpdateEntryHandle</span>, <span class="apiname">cwbUP_GetUpdateEntryHandle</span>, or to <span class="apiname">cwbUP_FindEntry</span>.</dd>
|
|
<dt class="dlterm">char * entryDescription - input/output</dt>
|
|
<dd>Pointer to a buffer that will receive the description of the update entry.</dd>
|
|
<dt class="dlterm">unsigned long bufferLength - input</dt>
|
|
<dd>Length of the buffer. An extra byte should be included for the null termination
|
|
character. If the buffer is not large enough to hold the entire description,
|
|
an error will be returned and the actualLength parameter will be set to the
|
|
number of bytes the entryDescription buffer needs to be to contain the data.</dd>
|
|
<dt class="dlterm">unsigned long * actualLength - input/output</dt>
|
|
<dd>Pointer to a length variable that will be set to the size of the buffer
|
|
needed to contain the description.</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_HANDLE</dt>
|
|
<dd>Update entry handle is not valid.</dd>
|
|
<dt class="dlterm">CWB_INVALID_POINTER</dt>
|
|
<dd>NULL passed as an address parameter.</dd>
|
|
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
|
|
<dd>Buffer is too small to hold return data.</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="rzaikufapilist5.htm" title="The following iSeries Access for Windows Directory Update are used to obtain information from an update entry and to retrieve general Directory Update information. The APIs are listed alphabetically.">Directory Update: Information APIs</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |