SplQpInstall: Difference between revisions
Created page with "SplQpInstall allows the user to configure a queue driver. This function is optional. ==Syntax== SplQpInstall(hwnd); ==Parameters== ; hwnd (HWND) - input : The window handle..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
SplQpInstall allows the user to configure a queue driver. This function is optional. | SplQpInstall allows the user to configure a queue driver. This function is optional. | ||
==Syntax== | ==Syntax== | ||
SplQpInstall(hwnd) | SplQpInstall(hwnd) | ||
==Parameters== | ==Parameters== | ||
; hwnd (HWND) - input | ; hwnd (HWND) - input: The window handle. | ||
: The window handle. | |||
==Return Code== | ==Return Code== | ||
; fSuccess (BOOL) - returns | ; fSuccess (BOOL) - returns: Return codes. | ||
: Return codes. | On completion, the handling routine must return BOOLEAN (fSuccess). | ||
On completion, the handling routine must return BOOLEAN (fSuccess). | * TRUE Success | ||
* TRUE Success | * FALSE Error | ||
* FALSE Error | |||
==Remarks== | ==Remarks== | ||
This function is called by the Workplace Shell. It is used to display a dialog to the user for queue driver (queue processor) configuration. The queue driver then stores the values in the OS2SYS.INI file. | This function is called by the Workplace Shell. It is used to display a dialog to the user for queue driver (queue processor) configuration. The queue driver then stores the values in the OS2SYS.INI file. | ||
==Example Code== | ==Example Code== | ||
<PRE> | <PRE> | ||
Latest revision as of 18:33, 2 July 2023
SplQpInstall allows the user to configure a queue driver. This function is optional.
Syntax
SplQpInstall(hwnd)
Parameters
- hwnd (HWND) - input
- The window handle.
Return Code
- fSuccess (BOOL) - returns
- Return codes.
On completion, the handling routine must return BOOLEAN (fSuccess).
- TRUE Success
- FALSE Error
Remarks
This function is called by the Workplace Shell. It is used to display a dialog to the user for queue driver (queue processor) configuration. The queue driver then stores the values in the OS2SYS.INI file.
Example Code
#include <os2.h> HWND hwnd; /* The window handle. */ BOOL fSuccess; /* Return codes. */ fSuccess = SplQpInstall(hwnd);