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

316 lines
15 KiB
HTML
Raw Permalink 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="cwbOBJ_GetObjAttr" />
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist2.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="cwbobj_getobjattr" />
<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>cwbOBJ_GetObjAttr</title>
</head>
<body id="cwbobj_getobjattr"><a name="cwbobj_getobjattr"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbOBJ_GetObjAttr</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Get an attribute of an object.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbOBJ_GetObjAttr(
cwbOBJ_ObjHandle objectHandle,
cwbOBJ_KeyID key,
void *buffer,
unsigned long bufLen,
unsigned long *bytesNeeded,
cwbOBJ_DataType *keyType,
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbOBJ_ObjHandle objectHandle - input</dt>
<dd>Handle of the object to get the attribute for.</dd>
<dt class="dlterm">cwbOBJ_KeyID key - input</dt>
<dd>Identifying key of the attribute to retrieve. The CWBOBJ_KEY_XXX constants
define the key ids. The type of object pointed to by objectHandle determine
which keys are valid.</dd>
<dt class="dlterm">void *buffer - output</dt>
<dd>The buffer that will hold the attribute value, if this call returns successfully.
The value of the key determines what type of data will be put into pBuffer.
The type is also returned to the *keyType parameter, if provided.</dd>
<dt class="dlterm">unsigned long bufLen - input</dt>
<dd>The length of the buffer pointed to by pBuffer.</dd>
<dt class="dlterm">unsigned long *bytesNeeded - output</dt>
<dd>On output, this will be the number of bytes needed to hold result.</dd>
<dt class="dlterm">cwbOBJ_DataType *keyType - output</dt>
<dd>Optional, may be NULL. On output this will contain the type of data used
to represent this attribute and what is stored at *buffer.</dd>
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
<dd>Optional, may be 0. Any returned messages will be written to this object.
It is created with the <span class="apiname">cwbSV_CreateErrHandle()</span> API. The
messages may be retrieved through the <span class="apiname">cwbSV_GetErrText()</span> API.
If the parameter is set to zero, no messages will be retrievable.</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_NO_ERROR</dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
<dd>Insufficient memory.</dd>
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
<dd>Handle is not an allocated object handle.</dd>
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
<dd>Buffer too small.</dd>
<dt class="dlterm">CWBOBJ_RC_HOST_ERROR</dt>
<dd>Host error occurred. Text may be in errorHandle.</dd>
<dt class="dlterm">CWBOBJ_RC_INVALID_KEY</dt>
<dd>Key isn't valid.</dd>
<dt class="dlterm">CWB_API_ERROR</dt>
<dd>General API failure.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The following attributes may be retrieved
for these object types: </p>
<ul><li>CWBOBJ_LIST_SPLF: <pre>CWBOBJ_KEY_AFP - AFP resources used
CWBOBJ_KEY_ALIGN - Align page
CWBOBJ_KEY_BKMGN_ACR - Back margin across
CWBOBJ_KEY_BKMGN_DWN - Back margin down
CWBOBJ_KEY_BKOVRLLIB - Back overlay library name
CWBOBJ_KEY_BKOVRLAY - Back overlay name
CWBOBJ_KEY_BKOVL_ACR - Back overlay offset across
CWBOBJ_KEY_BKOVL_DWN - Back overlay offset down
CWBOBJ_KEY_CPI - Characters per inch
CWBOBJ_KEY_CODEDFNTLIB - Coded font library name
CWBOBJ_KEY_CODEDFNT - Coded font
CWBOBJ_KEY_COPIES - Copies (total)
CWBOBJ_KEY_COPIESLEFT - Copies left to produce
CWBOBJ_KEY_CURPAGE - Current page
CWBOBJ_KEY_DATE - Date file was opened
CWBOBJ_KEY_PAGRTT - Degree of page rotation
CWBOBJ_KEY_ENDPAGE - Ending page
CWBOBJ_KEY_FILESEP - File separators
CWBOBJ_KEY_FOLDREC - Wrap text to next line
CWBOBJ_KEY_FONTID - Font identifier to use (default)
CWBOBJ_KEY_FORMFEED - Form feed
CWBOBJ_KEY_FORMTYPE - Form type
CWBOBJ_KEY_FTMGN_ACR - Front margin across
CWBOBJ_KEY_FTMGN_DWN - Front margin down
CWBOBJ_KEY_FTOVRLLIB - Front overlay library name
CWBOBJ_KEY_FTOVRLAY - Front overlay
CWBOBJ_KEY_FTOVL_ACR - Front overlay offset across
CWBOBJ_KEY_FTOVL_DWN - Front overlay offset down
CWBOBJ_KEY_CHAR_ID - Graphic character set
CWBOBJ_KEY_JUSTIFY - Hardware justification
CWBOBJ_KEY_HOLD - Hold the spool file
CWBOBJ_KEY_JOBNAME - Name of the job that created file
CWBOBJ_KEY_JOBNUMBER - Number of the job that created file
CWBOBJ_KEY_USER - Name of the user that created file
CWBOBJ_KEY_LASTPAGE - Last page that printed
CWBOBJ_KEY_LPI - Lines per inch
CWBOBJ_KEY_MAXRECORDS - Maximum number of records allowed
CWBOBJ_KEY_OUTPTY - Output priority
CWBOBJ_KEY_OUTQUELIB - Output queue library name
CWBOBJ_KEY_OUTQUE - Output queue
CWBOBJ_KEY_OVERFLOW - Overflow line number
CWBOBJ_KEY_PAGELEN - Page length
CWBOBJ_KEY_MEASMETHOD - Measurement method
CWBOBJ_KEY_PAGEWIDTH - Page width
CWBOBJ_KEY_MULTIUP - Logical pages per physical side
CWBOBJ_KEY_POINTSIZE - The default font's point size
CWBOBJ_KEY_FIDELITY - The error handling when printing
CWBOBJ_KEY_DUPLEX - Print on both sides of paper
CWBOBJ_KEY_PRTQUALITY - Print quality
CWBOBJ_KEY_PRTTEXT - Text printed at bottom of each page
CWBOBJ_KEY_PRTDEVTYPE - Printer dev type (data stream type)
CWBOBJ_KEY_PRTRFILELIB - Printer file library
CWBOBJ_KEY_PRTRFILE - Printer file
CWBOBJ_KEY_RECLENGTH - Record length
CWBOBJ_KEY_RPLUNPRT - Replace unprintable characters
CWBOBJ_KEY_RPLCHAR - Character to replace unprintables
CWBOBJ_KEY_RESTART - Where to restart printing at
CWBOBJ_KEY_SAVESPLF - Save file after printing
CWBOBJ_KEY_SRCDRWR - Source drawer
CWBOBJ_KEY_SPOOLFILE - Spool file name
CWBOBJ_KEY_SPLFNUM - Spool file number
CWBOBJ_KEY_SPLFSTATUS - Spool file status
CWBOBJ_KEY_STARTPAGE - Starting page to print
CWBOBJ_KEY_TIME - Time spooled file was opened at
CWBOBJ_KEY_PAGES - Number of pages in spool file
CWBOBJ_KEY_UNITOFMEAS - Unit of measure
CWBOBJ_KEY_USERCMT - User comment
CWBOBJ_KEY_USERDATA - User data
CWBOBJ_KEY_USRDFNDTA - User defined data
CWBOBJ_KEY_USRDFNOPTS - User defined options
CWBOBJ_KEY_USRDFNOBJ - User defined object
CWBOBJ_KEY_USRDFNOBJLIB- User defined object library
CWBOBJ_KEY_USRDFNOBJTYP- User defined object type</pre>
</li>
<li>CWBOBJ_LIST_OUTQ: <pre>CWBOBJ_KEY_AUTHCHCK - authority to check
CWBOBJ_KEY_DATAQUELIB - data queue library
CWBOBJ_KEY_DATAQUE - data queue
CWBOBJ_KEY_DESCRIPTION - text description
CWBOBJ_KEY_DISPLAYANY - users can display any file on queue
CWBOBJ_KEY_JOBSEPRATR - number of job separators
CWBOBJ_KEY_NUMFILES - total spooled files on output queue
CWBOBJ_KEY_NUMWRITERS - number of writers started to queue
CWBOBJ_KEY_OPCNTRL - operator controlled
CWBOBJ_KEY_ORDER - order on queue (sequence)
CWBOBJ_KEY_OUTQUELIB - output queue library name
CWBOBJ_KEY_OUTQUE - output queue
CWBOBJ_KEY_OUTQUESTS - output queue status
CWBOBJ_KEY_PRINTER - printer
CWBOBJ_KEY_SEPPAGE - print banner page
CWBOBJ_KEY_USRDFNDTA - user defined data
CWBOBJ_KEY_USRDFNOBJ - user defined object
CWBOBJ_KEY_USRDFNOBJLIB- user defined object library
CWBOBJ_KEY_USRDFNOBJTYP- user defined object type
CWBOBJ_KEY_USRDFNOPTS - user defined options
CWBOBJ_KEY_USRDRVPGM - user driver program
CWBOBJ_KEY_USRDRVPGMLIB- user driver program library
CWBOBJ_KEY_USRDRVPGMDTA- user driver program data
CWBOBJ_KEY_USRTFMPGM - user data transform program
CWBOBJ_KEY_USRTFMPGMLIB- user data transform program library
CWBOBJ_KEY_WRITER - writer job name
CWBOBJ_KEY_WTRJOBNUM - writer job number
CWBOBJ_KEY_WTRJOBSTS - writer job status
CWBOBJ_KEY_WTRJOBUSER - writer job user</pre>
</li>
<li>CWBOBJ_LIST_PRTD: <pre>CWBOBJ_KEY_AFP - AFP resources used
CWBOBJ_KEY_CODEPAGE - code page
CWBOBJ_KEY_DEVCLASS - device class
CWBOBJ_KEY_DEVMODEL - device model
CWBOBJ_KEY_DEVTYPE - device type
CWBOBJ_KEY_DRWRSEP - drawer to use for separators
CWBOBJ_KEY_FONTID - font identifier
CWBOBJ_KEY_FORMFEED - form feed
CWBOBJ_KEY_CHAR_ID - graphic character set
CWBOBJ_KEY_MFGTYPE - manufacturer's type &amp; model
CWBOBJ_KEY_MSGQUELIB - message queue library
CWBOBJ_KEY_MSGQUE - message queue
CWBOBJ_KEY_POINTSIZE - default font's point size
CWBOBJ_KEY_PRINTER - printer
CWBOBJ_KEY_PRTQUALITY - print quality
CWBOBJ_KEY_DESCRIPTION - text description
CWBOBJ_KEY_SCS2ASCII - transform SCS to ASCII
CWBOBJ_KEY_USRDFNDTA - user defined data
CWBOBJ_KEY_USRDFNOPTS - user defined options
CWBOBJ_KEY_USRDFNOBJLIB- user defined object library
CWBOBJ_KEY_USRDFNOBJ - user defined object
CWBOBJ_KEY_USRDFNOBJTYP- user defined object type
CWBOBJ_KEY_USRTFMPGMLIB- user data transform
program library
CWBOBJ_KEY_USRTFMPGM - user data transform program
CWBOBJ_KEY_USRDRVPGMDTA- user driver program data
CWBOBJ_KEY_USRDRVPGMLIB- user driver program library
CWBOBJ_KEY_USRDRVPGM - user driver program</pre>
</li>
<li>CWBOBJ_LIST_PRTF: <pre>CWBOBJ_KEY_ALIGN - align page
CWBOBJ_KEY_BKMGN_ACR - back margin across
CWBOBJ_KEY_BKMGN_DWN - back margin down
CWBOBJ_KEY_BKOVRLLIB - back side overlay library
CWBOBJ_KEY_BKOVRLAY - back side overlay name
CWBOBJ_KEY_BKOVL_DWN - back overlay offset down
CWBOBJ_KEY_BKOVL_ACR - back overlay offset across
CWBOBJ_KEY_CPI - characters per inch
CWBOBJ_KEY_CODEDFNTLIB - coded font library name
CWBOBJ_KEY_CODEPAGE - code page
CWBOBJ_KEY_CODEDFNT - coded font
CWBOBJ_KEY_COPIES - copies (total)
CWBOBJ_KEY_DBCSDATA - contains DBCS character set data
CWBOBJ_KEY_DBCSEXTENSN - process DBCS extension
characters
CWBOBJ_KEY_DBCSROTATE - rotate DBCS characters
CWBOBJ_KEY_DBCSCPI - DBCS CPI
CWBOBJ_KEY_DBCSSISO - DBCS SI/SO positioning
CWBOBJ_KEY_DFR_WRITE - defer write
CWBOBJ_KEY_PAGRTT - degree of page rotation
CWBOBJ_KEY_ENDPAGE - ending page number to print
CWBOBJ_KEY_FILESEP - number of file separators
CWBOBJ_KEY_FOLDREC - wrap text to next line
CWBOBJ_KEY_FONTID - Font identifier to use (default)
CWBOBJ_KEY_FORMFEED - type of paperfeed to be used
CWBOBJ_KEY_FORMTYPE - name of the form to be used
CWBOBJ_KEY_FTMGN_ACR - front margin across
CWBOBJ_KEY_FTMGN_DWN - front margin down
CWBOBJ_KEY_FTOVRLLIB - front side overlay library
CWBOBJ_KEY_FTOVRLAY - front side overlay name
CWBOBJ_KEY_FTOVL_ACR - front overlay offset across
CWBOBJ_KEY_FTOVL_DWN - front overlay offset down
CWBOBJ_KEY_CHAR_ID - graphic character set for this file
CWBOBJ_KEY_JUSTIFY - hardware justification
CWBOBJ_KEY_HOLD - hold the spool file
CWBOBJ_KEY_LPI - lines per inch
CWBOBJ_KEY_MAXRCDS - maximum number of records allowed
CWBOBJ_KEY_OUTPTY - output priority
CWBOBJ_KEY_OUTQUELIB - output queue library
CWBOBJ_KEY_OUTQUE - output queue
CWBOBJ_KEY_OVERFLOW - overflow line number
CWBOBJ_KEY_LINES_PAGE - page length in lines per page
CWBOBJ_KEY_PAGELEN - page length in Units of Measurement
CWBOBJ_KEY_MEASMETHOD - measurement method
(*ROWCOL or *UOM)
CWBOBJ_KEY_CHAR_LINE - page width in characters per line
CWBOBJ_KEY_PAGEWIDTH - width of page in Units of Measure
CWBOBJ_KEY_MULTIUP - logical pages per physical side
CWBOBJ_KEY_POINTSIZE - the default font's point size
CWBOBJ_KEY_FIDELITY - the error handling when printing
CWBOBJ_KEY_DUPLEX - print on both sides of paper
CWBOBJ_KEY_PRTQUALITY - print quality
CWBOBJ_KEY_PRTTEXT - text printed at bottom of each page
CWBOBJ_KEY_PRINTER - printer device name
CWBOBJ_KEY_PRTDEVTYPE - printer dev type (data stream type)
CWBOBJ_KEY_PRTRFILELIB - printer file library
CWBOBJ_KEY_PRTRFILE - printer file
CWBOBJ_KEY_RPLUNPRT - replace unprintable characters
CWBOBJ_KEY_RPLCHAR - character to replace unprintables
CWBOBJ_KEY_SAVE - save spooled file after printing
CWBOBJ_KEY_SRCDRWR - source drawer
CWBOBJ_KEY_SPOOL - spool the data
CWBOBJ_KEY_SCHEDULE - when available to the writer
CWBOBJ_KEY_STARTPAGE - starting page to print
CWBOBJ_KEY_DESCRIPTION - text description
CWBOBJ_KEY_UNITOFMEAS - unit of measure
CWBOBJ_KEY_USERDATA - user data
CWBOBJ_KEY_USRDFNDTA - User defined data
CWBOBJ_KEY_USRDFNOPTS - User defined options
CWBOBJ_KEY_USRDFNOBJLIB- User defined object library
CWBOBJ_KEY_USRDFNOBJ - User defined object
CWBOBJ_KEY_USRDFNOBJTYP- User defined object type</pre>
</li>
<li>CWBOBJ_LIST_WTR: <pre>CWBOBJ_KEY_WRITER - writer job name
CWBOBJ_KEY_WTRJOBNUM - writer job number
CWBOBJ_KEY_WTRJOBSTS - writer job status
CWBOBJ_KEY_WTRJOBUSER - writer job user</pre>
</li>
<li>CWBOBJ_LIST_LIB: <pre>CWBOBJ_KEY_LIBRARY - the library name
CWBOBJ_KEY_DESCRIPTION - description of the library</pre>
</li>
<li>CWBOBJ_LIST_RSC: <pre>CWBOBJ_KEY_RSCNAME - resource name
CWBOBJ_KEY_RSCLIB - resource library
CWBOBJ_KEY_RSCTYPE - resource object type
CWBOBJ_KEY_OBJEXTATTR - object extended attribute
CWBOBJ_KEY_DESCRIPTION - description of the resource
CWBOBJ_KEY_DATE - date object was last modified
CWBOBJ_KEY_TIME - time object was last modified</pre>
</li>
</ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist2.htm" title="The following iSeries Access for Windows APIs pertain to Objects. The APIs are listed alphabetically.">Object APIs for iSeries Access for Windows</a></div>
</div>
</div>
</body>
</html>