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

180 lines
8.5 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="cwbOBJ_SetObjAttrs" />
<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_setobjattrs" />
<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_SetObjAttrs</title>
</head>
<body id="cwbobj_setobjattrs"><a name="cwbobj_setobjattrs"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbOBJ_SetObjAttrs</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Change the attributes of the object on the
server.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbOBJ_SetObjAttrs(
cwbOBJ_ObjHandle objectHandle,
cwbOBJ_ParmHandle parmListHandle,
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbOBJ_ObjHandle objectHandle - input</dt>
<dd>Handle to the object that is to be changed.</dd>
<dt class="dlterm">cwbOBJ_ParmHandle parmListHandle - input</dt>
<dd>Handle to the parameter object which contains the attributes that are
to be modified for the object.</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">CWBOBJ_RC_HOST_ERROR</dt>
<dd>Host error occurred. Text may be in errorHandle.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The following objects allow these attributes
to be changed: </p>
<ul><li>CWBOBJ_LIST_SPLF (spooled files): <pre>CWBOBJ_KEY_ALIGN - Align page
CWBOBJ_KEY_BKOVRLLIB - Back overlay library name
CWBOBJ_KEY_BKOVRLAY - Back overlay
CWBOBJ_KEY_BKOVL_ACR - Back overlay offset across
CWBOBJ_KEY_BKOVL_DWN - Back overlay offset down
CWBOBJ_KEY_COPIES - Copies
CWBOBJ_KEY_ENDPAGE - Ending page
CWBOBJ_KEY_FILESEP - File separators
CWBOBJ_KEY_FORMFEED - Form feed
CWBOBJ_KEY_FORMTYPE - Form type
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_OUTPTY - Output priority
CWBOBJ_KEY_OUTQUELIB - Output queue library name
CWBOBJ_KEY_OUTQUE - Output queue
CWBOBJ_KEY_MULTIUP - Logical number of pages per side
CWBOBJ_KEY_FIDELITY - Print fidelity
CWBOBJ_KEY_DUPLEX - Print on both sides
CWBOBJ_KEY_PRTQUALITY - Print quality
CWBOBJ_KEY_PRTSEQUENCE - Print sequence
CWBOBJ_KEY_PRINTER - Printer
CWBOBJ_KEY_RESTART - Where to restart printing at
CWBOBJ_KEY_SAVESPLF - Save spooled file after printing
CWBOBJ_KEY_SCHEDULE - When spooled file available
CWBOBJ_KEY_STARTPAGE - Starting page
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_PRTF (printer files): <pre>CWBOBJ_KEY_ALIGN - Align page
CWBOBJ_KEY_BKMGN_ACR - Back margin offset across
CWBOBJ_KEY_BKMGN_DWN - Back margin offset down
CWBOBJ_KEY_BKOVRLLIB - Back overlay library name
CWBOBJ_KEY_BKOVRLAY - Back overlay
CWBOBJ_KEY_BKOVL_ACR - Back overlay offset across
CWBOBJ_KEY_BKOVL_DWN - Back overlay offset down
CWBOBJ_KEY_CPI - Characters Per Inch
CWBOBJ_KEY_CODEPAGE - Code page
CWBOBJ_KEY_CODEDFNTLIB - Coded font library name
CWBOBJ_KEY_CODEDFNT - Coded font name
CWBOBJ_KEY_COPIES - Copies
CWBOBJ_KEY_DBCSDATA - Contains DBCS Data
CWBOBJ_KEY_DBCSEXTENSN - Process DBCS Extension characters
CWBOBJ_KEY_DBCSROTATE - DBCS character rotation
CWBOBJ_KEY_DBCSCPI - DBCS CPI
CWBOBJ_KEY_DBCSSISO - DBCS SO/SI spacing
CWBOBJ_KEY_DFR_WRITE - Defer writing
CWBOBJ_KEY_ENDPAGE - Ending page
CWBOBJ_KEY_FILESEP - File Separators(*FILE not
allowed)
CWBOBJ_KEY_FOLDREC - Fold records
CWBOBJ_KEY_FONTID - Font identifier
CWBOBJ_KEY_FORMFEED - Form feed
CWBOBJ_KEY_FORMTYPE - Form type
CWBOBJ_KEY_FTMGN_ACR - Front margin offset across
CWBOBJ_KEY_FTMGN_DWN - Front margin offset 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 ID
CWBOBJ_KEY_JUSTIFY - Hardware Justification
CWBOBJ_KEY_HOLD - Hold spooled file
CWBOBJ_KEY_LPI - Lines per inch
CWBOBJ_KEY_MAXRECORDS - Maximum spooled file records
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 number of pages per side
CWBOBJ_KEY_POINTSIZE - The default font's point size
CWBOBJ_KEY_FIDELITY - Print fidelity
CWBOBJ_KEY_DUPLEX - Print on both sides
CWBOBJ_KEY_PRTQUALITY - Print quality
CWBOBJ_KEY_PRTTEXT - Print text
CWBOBJ_KEY_PRINTER - Printer
CWBOBJ_KEY_PRTDEVTYPE - Printer Device Type
CWBOBJ_KEY_RPLUNPRT - Replace unprintable characters
CWBOBJ_KEY_RPLCHAR - Replacement character
CWBOBJ_KEY_SAVESPLF - Save spooled file after printing
CWBOBJ_KEY_SRCDRWR - Source drawer
CWBOBJ_KEY_SPOOL - Spool the data
CWBOBJ_KEY_SCHEDULE - When spooled file available
CWBOBJ_KEY_STARTPAGE - Starting page
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_OUTQ (output queues):</li>
<li>CWBOBJ_LIST_PRTD (printer devices):</li>
<li>CWBOBJ_LIST_WTR (writers):</li>
<li>CWBOBJ_LIST_LIB (libraries): <ul><li>NONE</li>
</ul>
</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>