cwbOBJ_SetObjAttrs

Purpose

Change the attributes of the object on the server.

Syntax

 
unsigned int CWB_ENTRY cwbOBJ_SetObjAttrs(
                              cwbOBJ_ObjHandle   objectHandle,
                              cwbOBJ_ParmHandle  parmListHandle,
                              cwbSV_ErrHandle    errorHandle);

Parameters

cwbOBJ_ObjHandle objectHandle - input

Handle to the object that is to be changed.

cwbOBJ_ParmHandle parmListHandle - input

Handle to the parameter object which contains the attributes that are to be modified for the object.

cwbSV_ErrHandle errorHandle - output

Optional, may be 0. Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle() API. The messages may be retrieved through the cwbSV_GetErrText() API. If the parameter is set to zero, no messages will be retrievable.

Return Codes

The following list shows common return values.

CWB_NO_ERROR

Successful completion.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_INVALID_HANDLE

Handle is not an allocated object handle.

CWBOBJ_RC_HOST_ERROR

Host error occurred. Text may be in errorHandle.

Usage

The following objects allow these attributes to be changed:

• CWBOBJ_LIST_SPLF (spooled files):

  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

• CWBOBJ_LIST_PRTF (printer files):

  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

• CWBOBJ_LIST_OUTQ (output queues):
• CWBOBJ_LIST_PRTD (printer devices):
• CWBOBJ_LIST_WTR (writers):
• CWBOBJ_LIST_LIB (libraries):
  • NONE