Kyocera FS 1028DP User Manual

							KPDL Operators
7-129
com10envelope
(4.125 x 9.5 envelope)Set imageable area to
 Commercial 10 
envelope size. See  KPDL Printable Area  on 
page 140. This operator is in userdict. 
monarcenvelope
(3.875 x 7.5 envelope) Set imageable area to Monarch envelope size. 
See 
KPDL Printable Area on page 140. This 
operator is in userdict. 
com6envelope Set imageable area to Commercial 6 envelope 
size. See KPDL Printable Area  on page 140. 
This operator is in userdict. 
com9envelope
(3.75 x 8.875 envelope) Set imageable area to Commercial 9 envelope 
size. See KPDL Printable Area 
on page 140. 
This operator is in userdict. 
a5 Set imageable area to A5 size. See KPDL 
Printable Area  on page 140. This operator is in 
userdict. 
a6 Set imageable area to A6 size. See KPDL 
Printable Area  on page 140. This operator is in 
userdict. 
b6 Set imageable area to B6 size. See KPDL 
Printable Area  on page 140. This operator is in 
userdict. 
b5envelope Set imageable area to ISO B5 size. See KPDL 
Printable Area  on page 140. This operator is in 
userdict. 
c4envelope Set imageable area to c4 envelope size. See 
KPDL Printable Area  on page 140. This 
operator is in userdict. 
c5envelope Set imageable area to International C5 
envelope size. See  KPDL Printable Area  on 
page 140. This operator is in userdict. 
custom Set imageable area to custom size. See KPDL 
Printable Area  on page 140. This operator is in 
userdict. 
postcard Set imageable area to postcard size. See KPDL 
Printable Area  on page 140. This operator is in 
userdict. 
doublepostcard Set imageable area to double postcard size. See 
KPDL Printable Area  on page 140. This 
operator is in userdict. 
bool setdefaultduplexmode Select whether or not to print in duplex mode 
as default. (true: duplex, false: simplex)
defaultduplexmode bool Get default duplex mode setting (true: duplex, 
false: simplex) 
bool setduplexmode Set/cancel duplex mode. (true: duplex, false: 
simplex)
duplexmode boolGet current setting of duplex mode. (true: 
duplex, false: simplex)
bool setdefaulttumble Set duplex printing tumble mode for binding 
on short side (true) or long side (false) of page. 
defaulttumble bool Get the default tumble mode setting. (true: 
short-edge bind, false: long-edge bind) 
bool settumble Set tumble mode. (true: short-edge bind, false: 
long-edge bind) 
tumble boolGet current tumble  mode setting. (true: short-
edge bind, false: long-edge bind) 
firstside boolDuring duplex printing, returns whether the 
current print side is th e front or back. During 
simplex printing, return s whether the current 
page is even or odd. (true: front or odd page, 
false: back 

or even page) 
int setdefaultpapertray Set the default paper tray as:
0 : tray 1
1 : tray 2
2 : envelope feeder
3 : MP tray (Cassette mode)
4 : tray 3
5 : tray 4
6 : tray 5
7 : tray 6
Table 7.46.  KPDL Status Operators (Sheet 3 of 5)
Preceding stack Operator  Result  Description
Downloaded From ManualsPrinter.com Manuals 
						

							Chapter 7 Emulation
7-130
defaultpapertray intGet current default paper tray. 
int setpapertray Set current paper tray. 
papertray intGet current paper tray.
int setpapertray2 Select a tray by converting the tray number that 
is currently specified by the PRESCRIBE tray 
number into a KPDL tray number.
papertray2 intConvert the current tray number into a 
PRESCRIBE tray number.
PRESCRIBE tray numbers
0 : MP tray
1 : tray 1
2 : tray 1
3 : tray 1
4 : tray 1
5 : tray 1
6 : tray 1
99 : EF-1/UF-1 
bool setdefaulttrayswitch Set the default paper tray switch.
(true: Autocass, false: Autocass off) 
defaulttrayswitch bool Get default paper tray switch.
(true: Autocass, false: Autocass off) 
bool settrayswitch Set the current paper tray switch.
(true: Autocass, false: Autocass off) 
trayswitch boolGet the current paper tray switch.
(true: Autocass, false: Autocass off) 
a4tray Find tray containing A4 size paper, select it as 
current tray, and set imageable area for A4 size 
paper. 
a5tray Find tray containing A5 size paper, select it as 
current tray, and set imageable area for A5 size 
paper. 
a6tray Find tray containing A6 size paper, select it as 
current tray, and set imageable area for A6 size 
paper. 
b5tray Find tray containing B5 size paper, select it as 
current tray, and set imageable area for B5 size 
paper. 
b6tray Find tray containing B6 size paper, select it as 
current tray, and set imageable area for B6 size 
paper. 
legaltray Find tray containing legal size paper, select it 
as current tray, and set imageable area for legal 
size paper. 
lettertray Find tray containing letter size paper, select it 
as current tray, and set imageable area for letter 
size paper. 
executivetray Find tray containing executive size paper, 
select it as current tray, and set imageable area 
for executive size paper.
c4envelopetray Find tray containing International C4 
envelopes, select it as current tray, and set 
imageable area for International C4 
envelopes. 
c5envelopetray Find tray containing International C5 
envelopes, select it as current tray, and set 
imageable area for International C5 
envelopes. 
com10envelope-tray Find tray containing commercial #10 
envelopes, select it as current tray, and set 
imageable area for commercial #10 envelopes. 
com6envelope-tray Find tray containing commercial #6 
envelopes, select it as current tray, and set 
imageable area for commercial #6 envelopes. 
com9envelope-tray Find tray containing commercial #9 
envelopes, select it as current tray, and set 
imageable area for commercial #9 envelopes. 
Table 7.46.  KPDL Status Operators (Sheet 4 of 5)
Preceding stack Operator  Result  Description
Downloaded From ManualsPrinter.com Manuals 
						

							KPDL Operators
7-131
dlenvelopetrayFind tray containing DL size envelopes, select 
it as current tray, and set imageable area for DL 
size envelopes. 
monarcenvelopetray Find tray containing Monarch size envelopes, 
select it as current tray, and set imageable area 
for Monarch size envelopes. 
a3tray Find tray containing A3 size paper, select it as 
current tray, and set imageable area for A3 size 
paper. 
b4tray Find tray containing B4 size paper, select it as 
current tray, and set imageable area for B4 size 
paper. 
ledgertray Find tray containing ledger size paper, select it 
as current tray, and set imageable area for 
ledger size paper. 
b5envelopetray Find tray containing ISO B5 size paper, select 
it as current tray, and  set imageable area for 
ISO B5 size paper.
doublepostcardtray Find tray containing double postcard size 
paper, select it as current tray and set 
imageable area for double postcard size paper.
postcardtray Find tray containing postcard size paper, select 
it as current tray, and  set imageable area for 
postcard size paper.
customtray Find tray containing custom size paper, select 
it as current tray, and  set imageable area for 
custom size paper.
int setdefaultoutputtray Set the default output tray:
0 :  Upper tray (face down tray)
1 :  Lower tray (face up tray)
2 :  Option tray (sorter, etc.) 
defaultoutputtray int Get the default output tray. 
int setoutputtray Set the current output tray. 
outputtray intGet the current output tray. 
appletalktype string Get string object designating type of printing  system’ s AppleTalk name according to the 
AppleTalk Name Binding Protocol. 
doprinterrors bool Get setting of error information  printout mode. 
(true: error print mode on, false: error print 
mode off) 
bool  setdoautocontinue Set whether to display messages on front panel 
and wait for ONLINE key input when an error 
occurs. (true: do nothing, false: display error 
messages) 
doautocontinue bool Get setting of doautocontinue mode. (true: 
continue processing during errors, false: halt 
processing when ON LINE key is pressed) 
dojamrecovery bool Get setting of dojamrecovery mode. (true: 
perform jam recovery, false: do not perform 
jam recovery) 
usertime intGet time elapsed since beginning of job 
processing. 
#copies intGet integer objected indicating current 
number of copies setting. This operator is in 
userdict.
Table 7.46.  KPDL Status Operators (Sheet 5 of 5)
Preceding stack Operator  Result  Description
Downloaded From ManualsPrinter.com Manuals 
						

							Chapter 7 Emulation
7-132
KPDL System Parameters
The following table summarizes the system parameters.
Table 7.47.  KPDL System Parameters (Sheet 1 of 2)
Preceding stack Parameter  Result  Description
 BuildTime int Timestamp for printer’s date of manufacture
  ByteOrder bool Byte order of binary encoded tokens. (true: low-
order byte first, false: high-order byte first)
 CurDisplayList
aint Indicate in bytes the memory block size used for  storing DisplayList  for the current page. 
CurFontCache
aint Indicate in bytes the memo ry size used by the current 
font cache.
 CurFormCache
aint Indicate in bytes the memo ry size used by the current 
form cache.
 CurOutlineCache
aint Indicate in bytes the cache size used by  CharString on the current harddisk.
 CurPatternCache
aint Indicate in bytes the memo ry size used by the current 
pattern cache.
 CurScreenStorage
aint Indicate in bytes the memo ry size used by the current 
screen.
 CurSourceList
aint Indicate in bytes the host buffer size used by the  current input device.
 CurUPathCache
aint Indicate in bytes the memo ry size used by the current 
user path cache.
  DoAutoContinue bool Turn on/off the front panel display when a KPDL  error occurs (true: error display off, false: error 
display on).
  DoPrintErrors bool Turn on/off error printing when a KPDL error  occurs. (true: error print on, false: error print off)
  DoStartPage bool Indicate whether or  not to print status at power on as 
a bool object. (true: print  status, false: do not print 
status)
FactoryDefaults bool Indicate with a  boolean object whether to initialize 
the following parameters at power on (true: 
initialize, false: do not  initialize [factory default]).
SystemParamsPassword
StartJobPassword
FactoryDefaults
MaxFontCache
MaxDisplayList
MaxScreenStorage
MaxUPathCache
MaxPatternCache
MaxOutlineCache
MaxFormCache
FontResourceDir
GenericResourceDir
GenericResourcePathSep 
  FontResourceDir string Identify the font  resource directory on the harddisk. 
Defaults are in (fonts/). 
GenericResourceDir string Identify the dire ctory for resources other than fonts 
on the harddisk. Defaults are in (Resource/).
 GenericResource- PathSep string Specify the separator character used between 
resource identifiers on the harddisk. Defaults are in 
(/).
 JobTimeout int Indicate  the default job timeout value. 
MaxDisplayList int Indicate the maximum storage of  DisplayList for the 
current page. 
MaxFontCache int Indicate the maxi mum storage of the font cache.
  MaxFormCache int Indicate the maxi mum storage of the form cache. 
MaxOutlineCache int Indicate  the maximum storage of the CharString 
cache on the disk.
  MaxPatternCache int Indicate the maximum storage of the pattern cache. 
MaxScreenStorage int Indicate in bytes  the maximum storage of the half-
tone screen usable by the screen.
Downloaded From ManualsPrinter.com Manuals 
						

							KPDL Operators
7-133
 MaxSourceList int Indicate in bytes  the maximum storage of the host 
buffer used by the current input device. 
MaxUPathCache int Indicate in bytes the maximum storage which can be  used by the user path cache.
  PageCount int Indicate the total number of printed pages since the 
printer’s manufacture.
  Password int, string Indicate the  password necessary when changing 
system parameters and/ or device parameters.
  PrinterName string Indicate the name given to the printer.
  RamSize int Indicate in bytes th e total RAM capacity currently 
in the printer. 
RealFormat string Indicate the method  of representing the numeric 
values of binary tokens.
  Revision int Indicate the interpreter’s revision number.
  StartJobPassword int, string Indicate the password for  ExitServer and StartJob . 
StartupMode int Indicate by numeric value whether to execute the  (Sys/Start) file on the harddisk when first booting 
KPDL after power on. (0: default, 1: use Sys/Start)
 SystemParams- Password int, string Indicate the password for changing system 
parameters. 
WaitTimeout Indicate the default wait timeout value. 
MaxImageBuffer int Limit the workin g area for processing a single 
image.
  MaxStoredFontCache int Limit the maxi mum font cache value stored on the 
disk. 
CurStoredFontCache int Return in byte s the font cache value found on the 
current disk 
aRead only
Table 7.47.  KPDL System Parameters (Sheet 2 of 2)
Preceding stack Parameter  Result  Description
Downloaded From ManualsPrinter.com Manuals 
						

							Chapter 7 Emulation
7-134
KPDL User Parameters
The following table summarizes the user parameters. The user parameters establish tem-
porary policies on functions such as naming the current job for a user.
Table 7.48.  KPDL User Parameters
Preceding stack Parameter Result  Description
 AccurateScreens bool Turn  on/off the accurate mode flag for the  setscreen 
operator. (true: detail sc reen on, false: default)
  JobName string Return the name of the job currently being processed 
by the printer.
  JobTimeout int Return the current job timeout value.
  MaxDictStack int Indicate the maximum size of the dictionary stack.
  MaxExecStack int Indicate the ma ximum size of the execution stack.
  MaxFontItem int Indicate the maximum number of bytes used by a 
pixel array for a single character in the font cache.
  MaxFormItem int Indicate the maximum number of bytes used by the 
form of a single cached form.
 MaxLocalVM int Indicate  the maximu m number of bytes of the local 
VM.
  MaxOpStack int Indicate the maximum size of the operand stack.
  MaxPatternItem int Indicate the maxi mum number of bytes used by the 
form of a single  cached pattern. 
MaxScreenItem int Indicate the maximum number of bytes used by a  single half-tone screen.
  MaxUPathItem int Indicate the maximum number of bytes used by a 
single cached user path.
 MinFontCompress int Indicate  the thresh old value for storing characters in 
the font cache not as complete pixel arrays but in 
compressed form.
  VMReclaim int Indicate the automatic garbage collection mode.
  VMThreshold int Indicate the thre shold at which automatic garbage 
collection is executed once this number of bytes has 
been allocated after garbage collection.
  WaitTimeout int Return the current wait timeout value.
Downloaded From ManualsPrinter.com Manuals 
						

							KPDL Operators
7-135
KPDL Page Device Parameters
The page device parameters for setpagedevice allow manipulating the output devices to 
receive or provide various fini shing operations on the printed outputs. For example, the 
OutputType parameter allows to choose paper stack as follows:
To receive the output pages in the default printer stack:
 setpagedevice
To receive the output pages in  the finisher for stapling:
 setpagedevice 
Table 7.49.  KPDL Page Device Parameters (Sheet 1 of 3)
Preceding Stack Parameter Result Description
 BeginPage array Indicate BeginPage procedure operations. This 
parameter is called togeth er with the number of 
times  showpage  has executed since the beginning of 
the page. (default: {pop})
  Duplex bool Return as a boolean object the current duplex mode. 
(true: duplex, false: simplex)
 EndPage array Indicate EndPage procedure operations. This 
parameter is called togeth er with the number of 
times  showpage  has executed since the end of the 
page. (default: {exch pop 2 ne}) 
ExitJamRecovery bool Return as a boolean value whether to perform 
recovery when a paper  jam occurs. (Read only) 
[true]
  HWResolution array Indicate the resolution of the physical device. 
(300dpi: [300 300], 600dpi: [600 600], 1200dpi: 
[1200 1200]) 
ImagingBBox array Specify any bounding box for the entire page. 
(default: null) 
InputAttributes dict Indicate the dictionary associated with a currently 
available input device (paper tray) using the number 
assigned to each.
  Install array Execute the procedure for installing values during 
graphics mode when calling the setpagedevice 
operator. 
ManualFeed bool Set whether to perform manual feed. (true: MF on)
  ManualFeedTimeout int Return the manu al feed timeout. (Read only) [0]
  Margins array Set the printer margins. (default: [0 0])
  MediaColor string Use this parameter along with  /PageSize, 
/MediaWeight , and /MediaType  when the user 
selects a tray.
 MediaType string
aUse this parameter along with /PageSize, 
/MediaWeight , and /MediaColor  when the user 
selects a tray. For details on media type, see footnote 
below.
  MediaWeight int Use this parameter along with  /PageSize, 
/MediaType , and /MediaColor when the user selects 
a tray.
  NumCopies int Set the current copy count.
Normally null; when null is specified here,  #copies 
in  userdict  takes precedence.
 OutputAttributes dict Indicate the dictionary containing media output 
entries available for the current output device 
(printer output tray, sorter, etc.).
  OutputFaceUp bool Set the printer’s output stack.
(true: face up, false: face down)
  OutputType string Indicate parameters set by the user when selecting 
the output stack.  See example below.
  PageSize array Use this parameter along with  /MediaColor, 
/MediaWeight , and /MediaType  when the user 
selects a tray. Refer to KPDL Printable Area  on page 
140 (Ex: [612 792] LETTER, [595 842] A4).
Downloaded From ManualsPrinter.com Manuals 
						

							Chapter 7 Emulation
7-136
 Policies dict Execute the policies function. This is checked when 
the device cannot satisfy the user-specified 
setpagedevice .
  PostRendering-Enhance bool Turn on/off KIR mode. (true: KIR on, false: KIR off)
  PostRendering-EnhanceDetails dict Set the di ctionary representing the KIR mode when 
PostRenderingEnhance  is true. 
SorterDetails
bdict Set the dictionary object  for current sorter status 
information.
  TraySwitch bool Set the current auto cassette (mode status) using a 
boolean value.
(true: Autocass, false: Autocass off) 
Tumble bool Set the current tumble mode using a boolean value. 
(true: shortedge, false: longedge)
 DeferredMedia-Selection bool Define  using a boolean object the processing when 
the page size selected during page setup differs from 
the paper size of the tray.
(true: display cassette error)
  ProcessColorModel name Return the engine type as a name object.
/Device Gray: Monochrome
/Device CMY: Three colors
/Device CMYK: Four colors
  MediaPosition int Set the tray corresponding to the specified number 
as the current tray.
  OutputPage bool Set whether to output paper. 
(true: default, false: no output paper)
 Collate bool Turn on/off the collate function.
(true: electric collate on (only when harddisk is 
installed))
  CollateDetails dict Control the detailed parameters of the collate 
function. See  CollateDetails Parameters  on page 
138.
Fold int Fold booklet pages. (DF-75 finisher)
0: Do not fold
3: Fold
FoldDetails dict Control the detailed parameters of folding. See 
FoldMode  and FoldCount  below.
FoldMode int 1: Fold/staple booklet pages
FoldCopy int Control the number of pages to be folded.
0: Do not fold the pages whose number exceeds  the maximum
-1: Fold the rest of the pages whose number  exceeds the maximum
2: Fold every two pages
3: Fold every three pages ...
10: Fold every ten pages
  Jog int Jog the output every n pages as given by the integer 
code.
0: Do not jog
3 :  Jog using the given jog offset (only when 
optional stacker is installed)
  Staple int Staple the output every n pages as given by the 
integer code.
0: Do not staple
3 :  Staple when job is finished 
StapleDetails
cdict Control the detailed parameters of the staple  function.
EconoMode bool Control Econoprint mode.
true: Econoprint on
false: Econoprint off 
Punch
dint Punch output pages. (DF-71/DF-75) 0: Do not punch
3: Punch when a set of job is printed.
PunchDetails dict Controls the detailed parameters of the punch. 
See/PunchMode below.
Table 7.49.  KPDL Page Device Parameters (Sheet 2 of 3)
Preceding Stack Parameter Result Description
Downloaded From ManualsPrinter.com Manuals 
						

							KPDL Operators
7-137
PunchModeint Punch using sub style. (DF-71)
1: Native style of punching
2: Sub style
SlipSheet int Insert transparency separator.
0: No separator
3: Insert a separator when  a set of job is printed.
SlipSheetDetails dict Control the detailed parameters of punching. See 
CopyMode below.
CopyMode int Print on transparency separator.
1: Do not print on separator
2: Print on separator
PreRenderingEnhance bool Control resolution enhancement. When /HWResolution  is set to 600 dpi.
true: Fast 1200dpi
false: 600dpi
DeviceRenderingVividInfo dict Model FS-5900C only. Control vivid color mode. Ex:  >> setpagedevice
bool (true: Vivid mode on, false: Vivid mode off) 
DeviceRenderingRGBInfo dict Controls RGB emulation. Ex:  > >> setpagedevice
name
/sRGB
 >> setpagedevice
RGB emulation is not performed.
DeviceRenderingCMYKInfo dict Controls ink simulation. Ex: > >> setpagedevice
name
/SWOP
/EURO
/Normal: Normal ink simulation
 >> setpagedevice
Does not perform ink simulation.
aAvailable media type strings are as follows:
(Plain)
(Transparency)
(Preprinted)
(Labels)
(Bond)
(Recycled)
(Vellum)
(Rough)
(Letterhead)
(Color)
(Prepunched)
(Envelope)
(Card Stock)
(CoatedPaper)
(Duplex)
(Custom Type1)
(Custom Type2)
(Custom Type3)
(Custom Type4)
(Custom Type5)
(Custom Type6)
(Custom Type7)
(Custom Type8)
Table 7.49.  KPDL Page Device Parameters (Sheet 3 of 3)
Preceding Stack Parameter Result Description
Downloaded From ManualsPrinter.com Manuals 
						

							Chapter 7 Emulation
7-138
CollateDetails Parameters
CollateDetails has the following parameters as ta bled below according to the key of 
operations. By making / Collate true, CollateDetails  enables the printing system to 
implement the e-MPS function according to the keys explained in the following table.
Programming with Co llateDetails for Job Retention
CollateDetails enables the printing system to implement the e-MPS Job Retention func-
tion in KPDL mode. The /Mode key must be set to true for all of these functions. The 
bSorterDetails can specify tray arrangement and sorter  operation mode as the following example:
 >> 
setpagedevice
Tray arrangement array of [1 2] specifies tray 1 an d tray 2 to be used. If tray numbers are omitted ([ 
]), all trays are used. Sorter mode string of (S ORTER) specifes sorter mode. Other options include 
(COLLATOR) and (MAILBOX).
cA typical  StapleDetails  sequence is as follows. To staple e ach 20 pages at position 3 on the page:
 >> 
setpagedevice 
dTo punch in sub style, use the following example:
 >> setpagedevice
Table 7.50.  CollateDetails Parameters
Key Type Meaning  Parameters  default
/Mode integer Job mode  0:  HP Mopier mode/Job retention
1 : Volatile job
2 : Nonvolatile job
8 : VirtualMailbox job  0 
/Type integer Job Retention en able 8: Enable Job Retention —
/Hold integer Job Retention mode 1: QuickCopy
2: Stored job
3: Proof and Hold —
/HoldType integer Job Reten tion security 0: No security
1: Security with PIN code 0
/HoldKey integer PIN code Number of 4 bytes—
/Barcode integer Barcode output  0:  Output on first page
1 :  Output on all pages
2 : Do not output  2 
/BarcodePosition integer Barcode printing position (viewed in portrait 
orientation)  0
:  Lower right (bar only)
1 :  Lower right perpendicular (bar only)
2 :  Upper right perpendicular (bar only)
3 :  Upper right (bar only)
4 :  Upper left (bar only)
5 :  Upper left perpendicular (bar only)
6 :  Lower left perpendicular (bar only)
7 :  Lower left (bar only)
128 :  Lower right (bar + ID)
129 :  Lower right perpendicular (bar + ID)
130 :  Upper right perpendicular (bar + ID)
131 :  Upper right (bar + ID)
132 :  Upper left (bar + ID)
133 :  Upper left perpendicular (bar + ID)
134 :  Lower left perpendicular (bar + ID)
135 :  Lower left (bar + ID) 0
/Share integer Share flag 0: Shared 
1 : Not shared  0 
/Name string Job name  Character string up to 31 bytes maximum  () 
/User string User name  Character string up to 31 bytes maximum ()
/Time string Time stamp  Character string up to 31 bytes maximum ()
/Destination array VMB destination —[]
Downloaded From ManualsPrinter.com Manuals