SET_VSPRINTER Function [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== SET_VSPRINTER Function  ======


==== Description ====
 
Returns, and optionally overrides, the currently selected print engine (OIPI.Net (VSPRINTER2) or OIPI "classic" (VSPRINTER1)).

The override print processor (if any) will take effect immediately, regardless of the "cache" setting of the [[kb:kb_articles:printing_changes_102_oipi#cfg_oipi|CFG_OIPI]] record value in the SYSENV table.

The override remains in effect until the user logs out, or SET_VSPRINTER is invoked again, or [[[guides:programming:programmers_reference_manual:refresh_vsprinter|REFRESH_VSPRINTER]] is called.
 
==== Syntax ====
 
//currvalue// = **SET_VSPRINTER**(//desired_print_engine//, //debug_flag//, //topmost_flag//)
 
==== Parameters ====
 
The SET_VSPRINTER function has the following parameters.

^Parameter^Description^
|//desired_print_engine//|The print engine that should "override" any previous selection.  Values should be\\ \\ ? - Return the currently-selected print engine without changing it\\ 1 or VSPRINTER1 - Select VSPRINTER1 (OIPI "classic")\\ 2 or VSPRINTER2 - Select VSPRINTER2 (OIPI.Net)\\ "" or NONE - Remove any override|
|//debug_flag//|If set to "1", turns on OIPI debugging; if set to "0", turns off OIPI debugging.  Specify null ("") to leave this value unchanged|
|//topmost_flag//|If set to "1", instructs OIPI to remain the topmost window; if set to "0", removes the "topmost" flag.  Specify null ("") to leave this value unchanged|

==== Return Value ====

Returns the selected print processor in effect before any override parameter is applied.
 
==== Example ====
 
<code>
* Override the current print processor, whatever it is, to use VSPRINTER1 (OIPI "classic")
prev_value = SET_VSPRINTER("1")
* ... use VSPRINTER1 ...
* Remove the override
dummy_value = SET_PRINTER("")
</code>