winsplp.h header
This header is used by print. For more information, see:
winsplp.h contains the following programming interfaces:
Functions
| AddPortUI A port monitor UI DLL's AddPortUI function adds a printer port, then obtains port configuration information from the user and sends it to the port monitor server DLL. |
| AddPrintDeviceObject The AddPrintDeviceObject print provider function creates a device object for a print provider queue. |
| AppendPrinterNotifyInfoData The print spooler's AppendPrinterNotifyInfoData function adds the contents of a specified PRINTER_NOTIFY_INFO_DATA structure to a specified PRINTER_NOTIFY_INFO structure. |
| CallRouterFindFirstPrinterChangeNotification Describes the CallRouterFindFirstPrinterChangeNotification function. |
| ClosePort A language or port monitor's ClosePort function closes a printer port. |
| ClosePrintProcessor A print processor's ClosePrintProcessor function completes the printing of a print job and makes the associated handle invalid. |
| ConfigurePortUI A port monitor UI DLL's ConfigurePortUI function obtains port configuration information from the user and sends it to the port monitor server DLL. |
| ControlPrintProcessor A print processor's ControlPrintProcessor function allows the spooler to control a print job. |
| CreatePrinterIC Describes the CreatePrinterIC function. |
| DeletePortUI A port monitor UI DLL's DeletePortUI function deletes a printer port. |
| DeletePrinterIC Describes the DeletePrinterIC function. |
| DevQueryPrint Describes the DevQueryPrint function. |
| GenerateCopyFilePaths A Point and Print DLL's GenerateCopyFilePaths function is used for modifying the source and destination paths used by print spoolers when they copy print queue-associated files to a print client. |
| GetJobAttributes A print provider's GetJobAttributes function gets information about a print job. |
| GetJobAttributesEx A print provider's GetJobAttributesEx function obtains information about a print job, including N-up and reverse printing options. |
| GetPrintProcessorCapabilities A print processor's GetPrintProcessorCapabilities function returns capabilities associated with a specified input data type. |
| ImpersonatePrinterClient ImpersonatePrinterClient resumes impersonation of the client, completing the operation begun by RevertToPrinterSelf. |
| InitializeMonitor Describes the InitializeMonitor function. |
| InitializeMonitorEx Describes the InitializeMonitorEx function. |
| InitializePrintMonitor The InitializePrintMonitor function is obsolete and is supported only for compatibility purposes. |
| InitializePrintMonitor2 A print monitor's InitializePrintMonitor2 function initializes a print monitor for use with clustered print servers. |
| InitializePrintMonitorUI A port monitor UI DLL's InitializePrintMonitorUI function supplies the print spooler with addresses of DLL functions. |
| InitializePrintProvidor A print provider's InitializePrintProvidor function initializes the provider and supplies the print spooler with the provider's entry points. |
| LogJobInfoForBranchOffice Allows Branch Office clients to send job events to the host print server. |
| OpenPort A port monitor's OpenPort function opens a printer port. |
| OpenPrintProcessor A print processor's OpenPrintProcessor function prepares the print processor for printing a job and returns a handle. |
| PartialReplyPrinterChangeNotification The print spooler's PartialReplyPrinterChangeNotification function allows a print provider to update the spooler's database of printer changes associated with a notification handle. |
| PlayGdiScriptOnPrinterIC Describes the PlayGdiScriptOnPrinterIC function. |
| PrintDocumentOnPrintProcessor A print processor's PrintDocumentOnPrintProcessor function converts a print job from a spooled format into raw data that can be sent to a print monitor. |
| ProvidorFindClosePrinterChangeNotification Describes the ProvidorFindClosePrinterChangeNotification function. |
| ProvidorFindFirstPrinterChangeNotification Describes the ProvidorFindFirstPrinterChangeNotification function. |
| ReadPort A port monitor's ReadPort function reads data from a printer port. |
| RemovePrintDeviceObject The RemovePrintDeviceObject function removes a device object from a print provider queue. |
| ReplyPrinterChangeNotification The print spooler's ReplyPrinterChangeNotification function allows a print provider to update the spooler's database of print queue events associated with a notification handle, and to notify the client that print queue events have occurred. |
| ReplyPrinterChangeNotificationEx Describes the ReplyPrinterChangeNotificationEx function. |
| RevertToPrinterSelf When RevertToPrinterSelf is called on an impersonating thread, it returns the token for the thread that is being impersonated. |
| RouterAllocBidiMem RouterAllocBidiMem allocates a block of memory of a specified size. This function is used by the port monitor to allocate memory for strings and binary objects. |
| RouterAllocBidiResponseContainer RouterAllocBidiResponseContainer allocates a BIDI_RESPONSE_CONTAINER structure containing a list of bidi responses. The bidi response list is an array of BIDI_RESPONSE_DATA structures. |
| RouterAllocPrinterNotifyInfo The print spooler's RouterAllocPrinterNotifyInfo function allocates a PRINTER_NOTIFY_INFO structure and an array of PRINTER_NOTIFY_INFO_DATA structures. |
| RouterFreeBidiMem RouterFreeBidiMem frees a block of memory that was previously allocated by RouterAllocBidiMem. |
| RouterFreeBidiResponseContainer RouterFreeBidiResponseContainer frees a BIDI_RESPONSE_CONTAINER structure previously allocated by RouterAllocBidiResponseContainer. |
| RouterFreePrinterNotifyInfo The print spooler's RouterFreePrinterNotifyInfo function deallocates a specified PRINTER_NOTIFY_INFO structure and its associated PRINTER_NOTIFY_INFO_DATA structure array. |
| SplDeleteSpoolerPortEnd Describes the SplDeleteSpoolerPortEnd function. |
| SplDeleteSpoolerPortStart Describes the SplDeleteSpoolerPortStart function. |
| SplIsSessionZero The SplIsSessionZero function determines whether a certain print job (print handle plus job ID) was issued in session zero. |
| SplPromptUIInUsersSession The SplPromptUIInUsersSession function displays a standard message box in the session indicated by the printer handle and job ID. |
| SpoolerCopyFileEvent A Point and Print DLL's SpoolerCopyFileEvent function receives notifications of events associated with copying print queue-associated files to a print client, when the client connects to a print server. |
| SpoolerFindClosePrinterChangeNotification Describes the SpoolerFindClosePrinterChangeNotification function. |
| SpoolerFindFirstPrinterChangeNotification Describes the SpoolerFindFirstPrinterChangeNotification function. |
| SpoolerFindNextPrinterChangeNotification Describes the SpoolerFindNextPrinterChangeNotification function. |
| SpoolerFreePrinterNotifyInfo Learn more about: SpoolerFreePrinterNotifyInfo function |
| SpoolerRefreshPrinterChangeNotification Describes the SpoolerRefreshPrinterChangeNotification function. |
| UpdatePrintDeviceObject The UpdatePrintDeviceObject function updates the properties of a device object that is in the print provider queue. |
| WritePort A port monitor's WritePort function writes data to a printer port. |
| XcvClosePort A port monitor server DLL's XcvClosePort function closes a printer port that was opened by XcvOpenPort. |
| XcvDataPort A port monitor server DLL's XcvDataPort function receives information from, and returns information to, the port monitor's UI DLL. |
| XcvOpenPort A port monitor server DLL's XcvOpenPort function opens a port for configuration operations. |
Callback functions
| ROUTER_NOTIFY_CALLBACK Describes the ROUTER_NOTIFY_CALLBACK callback function. |
Structures
| ATTRIBUTE_INFO_3 Learn how the ATTRIBUTE_INFO_3 structure is used as a parameter for a printer interface DLL's DrvQueryJobAttributes function. All member values are function-supplied. |
| ATTRIBUTE_INFO_4 Learn how the ATTRIBUTE_INFO_4 structure is used as a parameter for a printer interface DLL's DrvQueryJobAttributes function. |
| BranchOfficeJobData This structure contains the type of event to log (eEventType), the job ID, and the data required by the event. |
| BranchOfficeJobDataContainer This structure defines a container for one or more BranchOfficeJobData structures to sent to a server. |
| BranchOfficeJobDataError This structure contains the necessary data for logging a branch office job failure event on a remote server. This is based on standard job-related data available to the spooler. |
| BranchOfficeJobDataPipelineFailed Contains the necessary data for logging a branch office job Pipeline Rendering Failed event on a remote server. This is based on standard job-related data available to the spooler. |
| BranchOfficeJobDataPrinted Contains the necessary data for logging a branch office job completed event on a remote server. This is based on standard job-related data available to the spooler. |
| BranchOfficeJobDataRendered Contains the necessary data for logging a branch office job Pipeline Rendering Event on a remote server. This is based on job-related data available to the spooler. |
| BranchOfficeLogOfflineFileFull Contains the necessary data for logging that the offline log archive on the current client overflowed at some point. |
| DOC_INFO_INTERNAL Describes the DOC_INFO_INTERNAL structure. |
| MESSAGEBOX_PARAMS The MESSAGEBOX_PARAMS structure is used by the SplPromptUIInUsersSession function to hold information about the appearance and behavior of a message box. |
| MONITOR The MONITOR structure is obsolete and is supported only for compatibility reasons. |
| MONITOR2 The MONITOR2 structure contains pointers to the functions defined by print monitors. |
| MONITOREX The MONITOREX structure is obsolete and supported for compatibility purposes only. |
| MONITORINIT The MONITORINIT structure is used as an input parameter to a print monitor's InitializePrintMonitor2 function. |
| MONITORREG The MONITORREG structure supplies print monitors with the address of registry functions to use instead of Win32 registry API functions. |
| MONITORUI The MONITORUI structure contains pointers to the functions within a port monitor UI DLL that the print spooler calls. |
| NOTIFICATION_CONFIG_1 Learn more about: _NOTIFICATION_CONFIG_1 structure |
| PRINTER_NOTIFY_INIT Learn more about: _PRINTER_NOTIFY_INIT structure |
| PRINTPROCESSOROPENDATA The PRINTPROCESSOROPENDATA structure is used as an input parameter to a print processor's OpenPrintProcessor function. |
| PRINTPROVIDOR The PRINTPROVIDOR structure is used as a parameter to a print provider's InitializePrintProvidor function. |
| SHOWUIPARAMS The SplPromptUIInUsersSession function uses the SHOWUIPARAMS structure to hold information about the appearance and behavior of a message box. |
| SPLCLIENT_INFO_1 The SPLCLIENT_INFO_1 structure is used as input to the GenerateCopyFilePaths function that is exported by Point and Print DLLs. |
| SPLCLIENT_INFO_2_LONGHORN Learn more about: _SPLCLIENT_INFO_2_V3 structure |
| SPLCLIENT_INFO_2_W2K Contains the handle for the server-side printer that is used to make direct API calls from the client to the server without the overhead of the RPC. |
| SPLCLIENT_INFO_2_WINXP Learn more about: _SPLCLIENT_INFO_2_V2 structure |
| SPLCLIENT_INFO_3_VISTA Contains a super-set of the information in both a SPLCLIENT_INFO_1 and SPLCLIENT_INFO_2 structure. It also contains additional information needed by the provider. |
| SPLCLIENT_INFO_INTERNAL The SPLCLIENT_INFO_INTERNAL structure is a super set of the information in splclient_info_1, splclient_info2 and splclient_info3 and contains additional information needed by the Device Control Defender code. |
Enumerations
| EBranchOfficeJobEventType Learn more about: EBranchOfficeJobEventType enumeration |
| NOTIFICATION_CALLBACK_COMMANDS Learn more about: _NOTIFICATION_CALLBACK_COMMANDS enumeration |
| NOTIFICATION_CONFIG_FLAGS Learn more about: _NOTIFICATION_CONFIG_FLAGS enumeration |
| UI_TYPE Learn more about: UI_TYPE enumeration |