103 lines
6.0 KiB
HTML
103 lines
6.0 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="CWBSO_GetObjAttr" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksoaapilist.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="cwbsogo" />
|
||
|
|
<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>CWBSO_GetObjAttr</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbsogo"><a name="cwbsogo"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">CWBSO_GetObjAttr</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Retrieves the value of an attribute from
|
||
|
|
an object.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY CWBSO_GetObjAttr(
|
||
|
|
CWBSO_OBJ_HANDLE objectHandle,
|
||
|
|
unsigned short usAttributeID,
|
||
|
|
char far* lpszBuffer,
|
||
|
|
unsigned long ulBufferLength,
|
||
|
|
unsigned long far* lpulBytesNeeded,
|
||
|
|
CWBSO_ERR_HANDLE errorHandle); </pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">CWBSO_OBJ_HANDLE objectHandle - input</dt>
|
||
|
|
<dd>A handle to an object that was returned by a previous call to <span class="apiname">CWBSO_GetObjHandle</span> or <span class="apiname">CWBSO_CopyObjHandle</span>.</dd>
|
||
|
|
<dt class="dlterm">unsigned short usAttributeID - input</dt>
|
||
|
|
<dd>The identifier of the attribute to be retrieved. The valid values for
|
||
|
|
this parameter depend on the type of object. See the appropriate header files
|
||
|
|
for the valid values: <ul><li>cwbsojob.h</li>
|
||
|
|
<li>cwbsomsg.h</li>
|
||
|
|
<li>cwbsoprt.h</li>
|
||
|
|
<li>cwbsosfl.h</li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">char far* lpszBuffer - output</dt>
|
||
|
|
<dd>A long pointer to the output buffer where the attribute value will be
|
||
|
|
placed. The value that is returned by this API is NOT a translated string.
|
||
|
|
For instance, *END would be returned instead of Ending page for the ending
|
||
|
|
page attribute of a spooled file. See <a href="rzaiksoaattrspecvalu.htm#soaattrspecvalu">SOA attribute special values</a> for
|
||
|
|
information on special values that may be returned for each type of object.
|
||
|
|
The output buffer is not changed when the return code is not set to CWBSO_NO_ERROR.</dd>
|
||
|
|
<dt class="dlterm">unsigned long ulBufferLength - input</dt>
|
||
|
|
<dd>The size, in bytes, of the output buffer argument.</dd>
|
||
|
|
<dt class="dlterm">unsigned long far* lpulBytesNeeded - output</dt>
|
||
|
|
<dd>A long pointer to an unsigned long that will be set to the number of bytes
|
||
|
|
needed to place the entire attribute value in the output buffer. When this
|
||
|
|
value is less than or equal to the size of output buffer that is specified,
|
||
|
|
the entire attribute value is placed in the output buffer. When this value
|
||
|
|
is greater than the size of output buffer that is specified, the output buffer
|
||
|
|
contains a null string. The output buffer is not changed beyond the bytes
|
||
|
|
that are needed for the attribute value. This value is set to zero when the
|
||
|
|
return code is not set to CWBSO_NO_ERROR.</dd>
|
||
|
|
<dt class="dlterm">CWBSO_ERR_HANDLE errorHandle - input</dt>
|
||
|
|
<dd>A handle to an error object. If an error occurs that there is error text
|
||
|
|
for, this handle may be used to retrieve the error message and message help.</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">CWBSO_NO_ERROR</dt>
|
||
|
|
<dd>No error occurred.</dd>
|
||
|
|
<dt class="dlterm">CWBSO_BAD_OBJ_HANDLE</dt>
|
||
|
|
<dd>The object handle that is specified is not valid.</dd>
|
||
|
|
<dt class="dlterm">CWBSO_BAD_ERR_HANDLE</dt>
|
||
|
|
<dd>The error handle that is specified is not valid.</dd>
|
||
|
|
<dt class="dlterm">CWBSO_BAD_ATTRIBUTE_ID</dt>
|
||
|
|
<dd>The attribute key is not valid for this object.</dd>
|
||
|
|
<dt class="dlterm">CWBSO_LOW_MEMORY</dt>
|
||
|
|
<dd>Not enough memory is available for the request.</dd>
|
||
|
|
<dt class="dlterm">CWBSO_ERROR_OCCURRED</dt>
|
||
|
|
<dd>An error occurred. Use error handle for more information.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p><span class="apiname">CWBSO_GetObjHandle</span> or <span class="apiname">CWBSO_CopyObjHandle</span> must
|
||
|
|
be called prior to calling this API. The object handle that is returned by <span class="apiname">CWBSO_GetObjHandle</span> or <span class="apiname">CWBSO_CopyObjHandle</span> must be passed as input to this API. <span class="apiname">CWBSO_CreateErrorHandle</span> must
|
||
|
|
be called prior to calling this API. The error handle that is returned by <span class="apiname">CWBSO_CreateErrorHandle</span> must
|
||
|
|
be passed as input to this API.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoaapilist.htm" title="The following System Object Access APIs for iSeries Access for Windows are listed alphabetically.">System Object Access APIs for iSeries Access for Windows List</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|