Skip navigation links
JNA API 5.14.0
com.sun.jna.platform.win32

Interface Winspool

    • Method Detail

      • EnumPrinters

        boolean EnumPrinters(int Flags,
                     java.lang.String Name,
                     int Level,
                     Pointer pPrinterEnum,
                     int cbBuf,
                     IntByReference pcbNeeded,
                     IntByReference pcReturned)
        The EnumPrinters function enumerates available printers, print servers, domains, or print providers.
        Parameters:
        Flags - The types of print objects that the function should enumerate.
        Name - If Level is 1, Flags contains PRINTER_ENUM_NAME, and Name is non-NULL, then Name is a pointer to a null-terminated string that specifies the name of the object to enumerate. This string can be the name of a server, a domain, or a print provider. If Level is 1, Flags contains PRINTER_ENUM_NAME, and Name is NULL, then the function enumerates the available print providers. If Level is 1, Flags contains PRINTER_ENUM_REMOTE, and Name is NULL, then the function enumerates the printers in the user's domain. If Level is 2 or 5,Name is a pointer to a null-terminated string that specifies the name of a server whose printers are to be enumerated. If this string is NULL, then the function enumerates the printers installed on the local computer. If Level is 4, Name should be NULL. The function always queries on the local computer. When Name is NULL, setting Flags to PRINTER_ENUM_LOCAL | PRINTER_ENUM_CONNECTIONS enumerates printers that are installed on the local machine. These printers include those that are physically attached to the local machine as well as remote printers to which it has a network connection. When Name is not NULL, setting Flags to PRINTER_ENUM_LOCAL | PRINTER_ENUM_NAME enumerates the local printers that are installed on the server Name.
        Level - The type of data structures pointed to by pPrinterEnum. Valid values are 1, 2, 4, and 5, which correspond to the PRINTER_INFO_1, PRINTER_INFO_2 , PRINTER_INFO_4, and PRINTER_INFO_5 data structures.
        pPrinterEnum - A pointer to a buffer that receives an array of PRINTER_INFO_1, PRINTER_INFO_2, PRINTER_INFO_4, or PRINTER_INFO_5 structures. Each structure contains data that describes an available print object. If Level is 1, the array contains PRINTER_INFO_1 structures. If Level is 2, the array contains PRINTER_INFO_2 structures. If Level is 4, the array contains PRINTER_INFO_4 structures. If Level is 5, the array contains PRINTER_INFO_5 structures. The buffer must be large enough to receive the array of data structures and any strings or other data to which the structure members point. If the buffer is too small, the pcbNeeded parameter returns the required buffer size.
        cbBuf - The size, in bytes, of the buffer pointed to by pPrinterEnum.
        pcbNeeded - A pointer to a value that receives the number of bytes copied if the function succeeds or the number of bytes required if cbBuf is too small.
        pcReturned - A pointer to a value that receives the number of PRINTER_INFO_1, PRINTER_INFO_2 , PRINTER_INFO_4, or PRINTER_INFO_5 structures that the function returns in the array to which pPrinterEnum points.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        EnumPrinters function

      • GetPrinter

        boolean GetPrinter(WinNT.HANDLE hPrinter,
                   int Level,
                   Pointer pPrinter,
                   int cbBuf,
                   IntByReference pcbNeeded)
        The GetPrinter function retrieves information about a specified printer.
        Parameters:
        hPrinter - A handle to the printer for which the function retrieves information. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.
        Level - The level or type of structure that the function stores into the buffer pointed to by pPrinter. This value can be 1, 2, 3, 4, 5, 6, 7, 8 or 9.
        pPrinter - A pointer to a buffer that receives a structure containing information about the specified printer. The buffer must be large enough to receive the structure and any strings or other data to which the structure members point. If the buffer is too small, the pcbNeeded parameter returns the required buffer size. The type of structure is determined by the value of Level.
        cbBuf - The size, in bytes, of the buffer pointed to by pPrinter.
        pcbNeeded - A pointer to a variable that the function sets to the size, in bytes, of the printer information. If cbBuf is smaller than this value, GetPrinter fails, and the value represents the required buffer size. If cbBuf is equal to or greater than this value, GetPrinter succeeds, and the value represents the number of bytes stored in the buffer.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        GetPrinter function

      • OpenPrinter

        boolean OpenPrinter(java.lang.String pPrinterName,
                    WinNT.HANDLEByReference phPrinter,
                    Winspool.LPPRINTER_DEFAULTS pDefault)
        The OpenPrinter function retrieves a handle to the specified printer or print server or other types of handles in the print subsystem.
        Parameters:
        pPrinterName - [in] A pointer to a null-terminated string that specifies the name of the printer or print server, the printer object, the XcvMonitor, or the XcvPort. For a printer object use: PrinterName, Job xxxx. For an XcvMonitor, use: ServerName, XcvMonitor MonitorName. For an XcvPort, use: ServerName, XcvPort PortName. If NULL, it indicates the local printer server.
        phPrinter - [out] A pointer to a variable that receives a handle (not thread safe) to the open printer or print server object. The phPrinter parameter can return an Xcv handle for use with the XcvData function. For more information about XcvData, see the DDK.
        pDefault - [in] A pointer to a PRINTER_DEFAULTS structure. This value can be NULL.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        OpenPrinter function

      • ClosePrinter

        boolean ClosePrinter(WinNT.HANDLE hPrinter)
        The ClosePrinter function closes the specified printer object.
        Note This is a blocking or synchronous function and might not return immediately.
        How quickly this function returns depends on run-time factors such as network status, print server configuration, and printer driver implementation-factors that are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user interface could make the application appear to be unresponsive.

        When the ClosePrinter function returns, the handle hPrinter is invalid, regardless of whether the function has succeeded or failed.

        Parameters:
        hPrinter - A handle to the printer object to be closed. This handle is returned by the OpenPrinter or AddPrinter function.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        ClosePrinter function

      • FindFirstPrinterChangeNotification

        @Deprecated
WinNT.HANDLE FindFirstPrinterChangeNotification(WinNT.HANDLE hPrinter,
                                                            int fdwFilter,
                                                            int fdwOptions,
                                                            WinDef.LPVOID pPrinterNotifyOptions)
        Deprecated. 

      • FindFirstPrinterChangeNotification

        WinNT.HANDLE FindFirstPrinterChangeNotification(WinNT.HANDLE hPrinter,
                                                int fdwFilter,
                                                int fdwOptions,
                                                Winspool.PRINTER_NOTIFY_OPTIONS pPrinterNotifyOptions)
        The FindFirstPrinterChangeNotification function creates a change notification object and returns a handle to the object. You can then use this handle in a call to one of the wait functions to monitor changes to the printer or print server. The FindFirstPrinterChangeNotification call specifies the type of changes to be monitored. You can specify a set of conditions to monitor for changes, a set of printer information fields to monitor, or both. A wait operation on the change notification handle succeeds when one of the specified changes occurs in the specified printer or print server. You then call the FindNextPrinterChangeNotification function to retrieve information about the change, and to reset the change notification object for use in the next wait operation.
        Parameters:
        hPrinter - [in] A handle to the printer or print server that you want to monitor. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.
        fdwFilter - The conditions that will cause the change notification object to enter a signaled state. A change notification occurs when one or more of the specified conditions are met. The fdwFilter parameter can be zero if pPrinterNotifyOptions is non-NULL.
        fdwOptions - Reserved; must be zero.
        pPrinterNotifyOptions - [in, optional] A pointer to a PRINTER_NOTIFY_OPTIONS structure. The pTypes member of this structure is an array of one or more PRINTER_NOTIFY_OPTIONS_TYPE structures, each of which specifies a printer information field to monitor. A change notification occurs when one or more of the specified fields changes. When a change occurs, the FindNextPrinterChangeNotification function can retrieve the new printer information. This parameter can be NULL if fdwFilter is nonzero. For a list of fields that can be monitored, see PRINTER_NOTIFY_OPTIONS_TYPE.
        Returns:
        If the function succeeds, the return value is a handle to a change notification object associated with the specified printer or print server. If the function fails, the return value is INVALID_HANDLE_VALUE.
        See Also:
        FindFirstPrinterChangeNotification function

      • FindNextPrinterChangeNotification

        boolean FindNextPrinterChangeNotification(WinNT.HANDLE hChange,
                                          WinDef.DWORDByReference pdwChange,
                                          Winspool.PRINTER_NOTIFY_OPTIONS pPrinterNotifyOptions,
                                          PointerByReference ppPrinterNotifyInfo)
        The FindNextPrinterChangeNotification function retrieves information about the most recent change notification for a change notification object associated with a printer or print server. Call this function when a wait operation on the change notification object is satisfied. The function also resets the change notification object to the not-signaled state. You can then use the object in another wait operation to continue monitoring the printer or print server. The operating system will set the object to the signaled state the next time one of a specified set of changes occurs to the printer or print server. The FindFirstPrinterChangeNotification function creates the change notification object and specifies the set of changes to be monitored.
        Parameters:
        hChange - [in] A handle to a change notification object associated with a printer or print server. You obtain such a handle by calling the FindFirstPrinterChangeNotification function. The operating system sets this change notification object to the signaled state when it detects one of the changes specified in the object's change notification filter.
        pdwChange - [out, optional] A pointer to a variable whose bits are set to indicate the changes that occurred to cause the most recent notification. The bit flags that might be set correspond to those specified in the fdwFilter parameter of the FindFirstPrinterChangeNotification call. The system sets one or more of the following bit flags.
        pPrinterNotifyOptions - [in, optional] A pointer to a PRINTER_NOTIFY_OPTIONS structure. Set the Flags member of this structure to PRINTER_NOTIFY_OPTIONS_REFRESH, to cause the function to return the current data for all monitored printer information fields. The function ignores all other members of the structure. This parameter can be NULL.
        ppPrinterNotifyInfo - [out, optional] A pointer to a pointer variable that receives a pointer to a system-allocated, read-only buffer. Call the FreePrinterNotifyInfo function to free the buffer when you are finished with it. This parameter can be NULL if no information is required. The buffer contains a PRINTER_NOTIFY_INFO structure, which contains an array of PRINTER_NOTIFY_INFO_DATA structures. Each element of the array contains information about one of the fields specified in the pPrinterNotifyOptions parameter of the FindFirstPrinterChangeNotification call. Typically, the function provides data only for the fields that changed to cause the most recent notification. However, if the structure pointed to by the pPrinterNotifyOptions parameter specifies PRINTER_NOTIFY_OPTIONS_REFRESH, the function provides data for all monitored fields. If the PRINTER_NOTIFY_INFO_DISCARDED bit is set in the Flags member of the PRINTER_NOTIFY_INFO structure, an overflow or error occurred, and notifications may have been lost. In this case, no additional notifications will be sent until you make a second FindNextPrinterChangeNotification call that specifies PRINTER_NOTIFY_OPTIONS_REFRESH.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        FindClosePrinterChangeNotification function

      • FindClosePrinterChangeNotification

        boolean FindClosePrinterChangeNotification(WinNT.HANDLE hChange)
        The FindClosePrinterChangeNotification function closes a change notification object created by calling the FindFirstPrinterChangeNotification function. The printer or print server associated with the change notification object will no longer be monitored by that object.
        Parameters:
        hChange - [in] A handle to the change notification object to be closed. This is a handle created by calling the FindFirstPrinterChangeNotification function.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        FindClosePrinterChangeNotification function

      • FreePrinterNotifyInfo

        boolean FreePrinterNotifyInfo(Pointer pPrinterNotifyInfo)
        The FreePrinterNotifyInfo function frees a system-allocated buffer created by the FindNextPrinterChangeNotification function.
        Parameters:
        pPrinterNotifyInfo - [in] Pointer to a PRINTER_NOTIFY_INFO buffer returned from a call to the FindNextPrinterChangeNotification function. FreePrinterNotifyInfo deallocates this buffer.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        FreePrinterNotifyInfo function

      • EnumJobs

        boolean EnumJobs(WinNT.HANDLE hPrinter,
                 int FirstJob,
                 int NoJobs,
                 int Level,
                 Pointer pJob,
                 int cbBuf,
                 IntByReference pcbNeeded,
                 IntByReference pcReturned)
        The EnumJobs function retrieves information about a specified set of print jobs for a specified printer.
        Parameters:
        hPrinter - A handle to the printer object whose print jobs the function enumerates. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.
        FirstJob - The zero-based position within the print queue of the first print job to enumerate. For example, a value of 0 specifies that enumeration should begin at the first print job in the print queue; a value of 9 specifies that enumeration should begin at the tenth print job in the print queue.
        NoJobs - The total number of print jobs to enumerate.
        Level - The type of information returned in the pJob buffer.
        pJob - A pointer to a buffer that receives an array of JOB_INFO_1, JOB_INFO_2, or JOB_INFO_3 structures. The buffer must be large enough to receive the array of structures and any strings or other data to which the structure members point.
        cbBuf - The size, in bytes, of the pJob buffer.
        pcbNeeded - A pointer to a variable that receives the number of bytes copied if the function succeeds. If the function fails, the variable receives the number of bytes required.
        pcReturned - A pointer to a variable that receives the number of JOB_INFO_1, JOB_INFO_2, or JOB_INFO_3 structures returned in the pJob buffer.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        EnumJobs function

      • SetJob

        boolean SetJob(WinNT.HANDLE hPrinter,
               int JobId,
               int Level,
               Pointer pJob,
               int Command)
        The SetJob function pauses, resumes, cancels, or restarts a print job on a specified printer. You can also use the SetJob function to set print job parameters, such as the print job priority and the document name. You can use the SetJob function to give a command to a print job, or to set print job parameters, or to do both in the same call. The value of the Command parameter does not affect how the function uses the Level and pJob parameters. Also, you can use SetJob with JOB_INFO_3 to link together a set of print jobs.
        Parameters:
        hPrinter - [in] A handle to the printer object of interest. Use the OpenPrinter, OpenPrinter2, or AddPrinter function to retrieve a printer handle.
        JobId - [in] Identifier that specifies the print job. You obtain a print job identifier by calling the AddJob function or the StartDoc function. If the Level parameter is set to 3, the JobId parameter must match theJobId member of the JOB_INFO_3 structure pointed to by pJob
        Level - [in] The type of job information structure pointed to by the pJob parameter. All versions of Windows: You can set the Level parameter to 0, 1, or 2. When you set Level to 0, pJob be NULL. Use these values when you are not setting any print job parameters. You can also set the Level parameter to 3. Starting with Windows Vista: You can also set the Level parameter to 4.
        pJob - [in] A pointer to a structure that sets the print job parameters. All versions of Windows: pJob can point to a JOB_INFO_1 or JOB_INFO_2 structure. pJob can also point to a JOB_INFO_3 structure. You must have JOB_ACCESS_ADMINISTER access permission for the jobs specified by the JobId and NextJobId members of the JOB_INFO_3 structure. Starting with Windows Vista: pJob can also point to a JOB_INFO_4 structure. If the Level parameter is 0, pJob should be NULL.
        Command - [in] The print job operation to perform. This parameter can be one of the JOB_CONTROL_XXX values. To cancel a job, do NOT use JOB_CONTROL_CANCEL, intead use JOB_CONTROL_DELETE to delete a job.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero.
        See Also:
        SetJob function

      • SetPrinter

        boolean SetPrinter(WinNT.HANDLE hPrinter,
                   int Level,
                   Pointer pPrinter,
                   int Command)
        The SetPrinter function sets the data for a specified printer or sets the state of the specified printer by pausing printing, resuming printing, or clearing all print jobs.
        Parameters:
        hPrinter - [in] A handle to the printer. Use the OpenPrinter, OpenPrinter2, or AddPrinter function to retrieve a printer handle.
        Level - [in] The type of data that the function stores into the buffer pointed to by pPrinter. If the Command parameter is not equal to zero, the Level parameter must be zero. This value can be 0, 2, 3, 4, 5, 6, 7, 8, or 9.
        pPrinter - A pointer to a buffer containing data to set for the printer, or containing information for the command specified by the Command parameter. The type of data in the buffer is determined by the value of Level.
        Command - The action to perform. If the Level parameter is nonzero, set the value of this parameter to zero. In this case, the printer retains its current state and the function reconfigures the printer data as specified by the Level and pPrinter parameters. If the Level parameter is zero, set the value of this parameter to one of the PRINTER_CONTROL_XXX values.
        Returns:
        If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. If Level is 7 and the publish action failed, SetPrinter returns ERROR_IO_PENDING and attempts to complete the action in the background. If Level is 7 and the update action failed, SetPrinter returns ERROR_FILE_NOT_FOUND.
        See Also:
        SetPrinter function
Skip navigation links
JNA API 5.14.0

Copyright © 2007-2018 Timothy Wall. All Rights Reserved.