70 lines
3.8 KiB
HTML
70 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="cwbCO_GetDescription" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist4.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="cwbco_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>cwbCO_GetDescription</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_getdescription"><a name="cwbco_getdescription"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_GetDescription</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function gets the text description
|
||
|
|
associated with a specified system object.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
UINT CWB_ENTRY cwbCO_GetDescription(
|
||
|
|
cwbCO_SysHandle system,
|
||
|
|
LPSTR description,
|
||
|
|
PULONG length );</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
|
||
|
|
<dd>Handle returned previously from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
|
||
|
|
It identifies the iSeries™ system.</dd>
|
||
|
|
<dt class="dlterm">LPSTR description - output</dt>
|
||
|
|
<dd>Pointer to a buffer that will contain the NULL-terminated description.
|
||
|
|
The description will be at most CWBCO_MAX_SYS_DESCRIPTION characters long,
|
||
|
|
not including the terminating NULL.</dd>
|
||
|
|
<dt class="dlterm">PULONG length - input/output</dt>
|
||
|
|
<dd>Pointer to the length of the description buffer. If the buffer is too
|
||
|
|
small to hold the description, including space for the terminating NULL, the
|
||
|
|
size of the buffer needed will be filled into this parameter.</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_API_HANDLE</dt>
|
||
|
|
<dd>Invalid system handle.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_POINTER</dt>
|
||
|
|
<dd>One of the pointer parameters passed in is NULL.</dd>
|
||
|
|
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
|
||
|
|
<dd>The description buffer is not large enough to hold the entire description.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist4.htm" title="Use the APIs to get and set other system object attributes, or determine if the attributes are restricted by policies.">Communications and security: Get and set attribute APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|