VioPrtScToggle: Difference between revisions
m Ak120 moved page OS2 API:CPI:LEGACY:VioPrtScToggle to VioPrtScToggle |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This call is called by the Session Manager when the operator presses Ctrl and PrtSc. | This call is called by the Session Manager when the operator presses Ctrl and PrtSc. | ||
==Syntax== | ==Syntax== | ||
VioPrtScToggle (VioHandle) | |||
VioPrtScToggle | |||
==Parameters== | ==Parameters== | ||
; | ;VioHandle (HVIO) - input : Reserved word of 0s. | ||
==Return Code== | ==Return Code== | ||
rc (USHORT) - return | rc (USHORT) - return | ||
Return code descriptions are: | Return code descriptions are: | ||
* 0 NO_ERROR | |||
* 0 NO_ERROR | * 355 ERROR_VIO_MODE | ||
* 355 ERROR_VIO_MODE | |||
* 402 ERROR_VIO_SMG_ONLY | * 402 ERROR_VIO_SMG_ONLY | ||
* 430 ERROR_VIO_ILLEGAL_DURING_POPUP | * 430 ERROR_VIO_ILLEGAL_DURING_POPUP | ||
| Line 27: | Line 23: | ||
Three beeps are generated if a hard error is detected while writing to the printer. When Ctrl and PrtSc is turned off, the operator may have to press the Enter key to cause output spooled while Ctrl and PrtSc was active to be printed. This is because the spool files are closed when the next VioWrtTTY is executed in the session, such as writing the prompt in response to the Enter key. | Three beeps are generated if a hard error is detected while writing to the printer. When Ctrl and PrtSc is turned off, the operator may have to press the Enter key to cause output spooled while Ctrl and PrtSc was active to be printed. This is because the spool files are closed when the next VioWrtTTY is executed in the session, such as writing the prompt in response to the Enter key. | ||
==Example Code== | ==Example Code== | ||
===C Binding=== | ===C Binding=== | ||
<PRE> | <PRE> | ||
| Line 35: | Line 31: | ||
USHORT rc = VioPrtScToggle(VioHandle); | USHORT rc = VioPrtScToggle(VioHandle); | ||
HVIO | HVIO VioHandle; /* Vio handle */ | ||
USHORT rc; /* return code */ | |||
USHORT | |||
</PRE> | </PRE> | ||
=== MASM Binding=== | === MASM Binding=== | ||
| Line 49: | Line 44: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
[[Category: | [[Category:Vio]] | ||
Revision as of 04:59, 13 February 2017
This call is called by the Session Manager when the operator presses Ctrl and PrtSc.
Syntax
VioPrtScToggle (VioHandle)
Parameters
- VioHandle (HVIO) - input
- Reserved word of 0s.
Return Code
rc (USHORT) - return
Return code descriptions are:
- 0 NO_ERROR
- 355 ERROR_VIO_MODE
- 402 ERROR_VIO_SMG_ONLY
- 430 ERROR_VIO_ILLEGAL_DURING_POPUP
- 436 ERROR_VIO_INVALID_HANDLE
- 465 ERROR_VIO_DETACHED
Remarks
VioPrtScToggle toggles the Ctrl and PrtSc state of the foreground session. When the Ctrl and PrtSc state is on, all VioWrtTTY calls from that session are echoed to the print device.
VioPrtScToggle can only be called by the session manager. If an application issues this call, it receives an error code.
Three beeps are generated if a hard error is detected while writing to the printer. When Ctrl and PrtSc is turned off, the operator may have to press the Enter key to cause output spooled while Ctrl and PrtSc was active to be printed. This is because the spool files are closed when the next VioWrtTTY is executed in the session, such as writing the prompt in response to the Enter key.
Example Code
C Binding
#define INCL_VIO USHORT rc = VioPrtScToggle(VioHandle); HVIO VioHandle; /* Vio handle */ USHORT rc; /* return code */
MASM Binding
EXTRN VioPrtScToggle:FAR INCL_VIO EQU 1 PUSH WORD VioHandle ;Vio handle CALL VioPrtScToggle Returns WORD