Jump to content

SplDisplayControlPanel

From EDM2
Revision as of 03:35, 12 December 2019 by Martini (talk | contribs) (Created page with "This function displays a control panel for a printer that is communicating bidirectionally. == Syntax == SplDisplayControlPanel(pszComputerName, pszPortName, pszDev...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This function displays a control panel for a printer that is communicating bidirectionally.

Syntax

SplDisplayControlPanel(pszComputerName,
      pszPortName, pszDeviceID, pszControlPanel,
      hab, flCapabilities);

Parameters

pszComputerName (PSZ) - input
Printer server name for displaying a remote printer panel from a client machine.
This parameter is NULL for printers whose ports exist on the current machine.
pszPortName (PSZ) - input
Printer port name.
The name of the printer port for pszComputerName, used to display a control panel. Following is an example of a port name:
 LPT1 
pszDeviceID (PSZ) - input
Device ID, if known, for the printer connected to pszPortName.
pszControlPanel (PSZ) - input
Name of control panel to call to display the front panel for this printer.
This name can be one of the following:
  • The name registered with SplRegisterControlPanel
  • One of the control panel names returned by SplGetControlPanelList
hab (HAB) - input
Anchor block handle.
flCapabilities (ULONG) - input
Capabilities requested.
FL_ADMIN - 0x00000001
Set if an administrator wants the control panel.

Returns

rc (ULONG) - returns
Return codes.
  • 0 Success
ERROR_INVALID_NAME(123)
pszName is not the name of a control panel DLL.
ERROR_NOT_SUPPORTED(50)
A control panel for this printer is not supported by the called control panel DLL.


Sample

#define INCL_SPL
#define INCL_SPLBIDI
#include <os2.h>

PSZ      pszComputerName;  /*  Printer server name for displaying a remote printer panel from a client machine. */
PSZ      pszPortName;      /*  Printer port name. */
PSZ      pszDeviceID;      /*  Device ID, if known, for the printer connected to pszPortName. */
PSZ      pszControlPanel;  /*  Name of control panel to call to display the front panel for this printer. */
HAB      hab;              /*  Anchor block handle. */
ULONG    flCapabilities;   /*  Capabilities requested. */
ULONG    rc;               /*  Return codes. */

rc = SplDisplayControlPanel(pszComputerName,
       pszPortName, pszDeviceID, pszControlPanel,
       hab, flCapabilities);