Please use FireFox to view this page

Visual Basic 6 definition

Declare Function EnumJobs Lib "winspool.drv" Alias "EnumJobsA" (ByVal hPrinter As Long, ByVal FirstJob As Long, ByVal NoJobs As Long, ByVal Level As Long, pJob As Long, ByVal cbBuf As Long, pcbNeeded As Long, pcReturned As Long) As Long

Visual Basic .NET definition

Declare Function EnumJobs Lib "winspool.drv" Alias "EnumJobsA"(ByVal hPrinter As Integer, ByVal FirstJob As Integer, ByVal NoJobs As Integer, ByVal Level As Integer, ByRef pJob As Byte, ByVal cdBuf As Integer, ByRef pcbNeeded As Integer, ByRef pcReturned As Integer) As Integer

C# definition

[DllImport("winspool.drv", EntryPoint="EnumJobs")] public static extern int EnumJobsA(int hPrinter, int FirstJob, int NoJobs, int Level, ref byte pJob, int cdBuf, ref int pcbNeeded, ref int pcReturned)

Description

EnumJobs enumerates all of the print jobs pending for a given printer. The function can retrieve either (relatively) brief or detailed information describing each job in the print queue for that printer. Note that, instead of placing the information directly into the corresponding structures, the function places the information into an array. The array's contents must then be transfered to one or more structures. In order to determine how much space is necessary to receive the information about each print job, first call the function with cbBuf set to 0. The function will set the variable passed as pcbNeeded to the size in bytes of the array necessary hold the information.

Return Value

If an error occured, the function returns 0 (use GetLastError to get the error code). If successful, the function returns a non-zero value.

Parameters

hPrinter A handle to the printer to enumerate the print jobs of. FirstJob The zero-baded position in the print queue to begin print job enumeration from. To enumerate all jobs, of course set this to 0. To enumerate everything except the first job, set this to 1 (identifying the second print job), etc. NoJobs The maximum number of print jobs to enumerate. Level Identifies the format of the information placed into the array passed as pJob. If this is 1, the data is in the format of JOB_INFO_1 structures. If this is 2, the data is in the format of JOB_INFO_2 structures. pJob An array which receives all the information about the print jobs retrieved by the function. The format of this data is specified in Level. The array must be large enough to receive all the data. If you are setting cbBuf to 0, this must also be 0. cbBuf The size in bytes of the array passed as pJob. To determine how large the array must be, set this to 0. pcbNeeded Receives the number of bytes of data copied into the array passed as pJob. If the function failed, this is the minimum size in bytes which the array passed as pJob must be. pcReturned Receives the number of print jobs retrieved by the function.

Further Information:

For further information on Windows API functions such as these, and how to use these API's in your C# and VB.NET applications, please refer to the book 'Network programming in .NET' (Buy at Amazon UK) (Buy at Amazon US)

Visual Basic 6 example source code
Private Declare Function OpenPrinter Lib "winspool.drv" Alias "OpenPrinterA" (ByVal pPrinterName As String, phPrinter As Long, pDefault As Any) As Long Private Declare Function ClosePrinter Lib "winspool.drv" (ByVal hPrinter As Long) As Long Private Declare Function EnumJobs Lib "winspool.drv" Alias "EnumJobsA" (ByVal hPrinter As Long, ByVal FirstJob As Long, ByVal NoJobs As Long, ByVal Level As Long, pJob As Any, ByVal cdBuf As Long, pcbNeeded As Long, pcReturned As Long) As Long Private Sub Form_Load() 'KPD-Team 2001 'URL: http://www.allapi.net/ 'E-Mail: KPDTeam@Allapi.net Dim hPrinter As Long, lNeeded As Long, lReturned As Long Dim lJobCount As Long OpenPrinter Printer.DeviceName, hPrinter, ByVal 0& EnumJobs hPrinter, 0, 99, 1, ByVal 0&, 0, lNeeded, lReturned If lNeeded > 0 Then ReDim byteJobsBuffer(lNeeded - 1) As Byte EnumJobs hPrinter, 0, 99, 1, byteJobsBuffer(0), lNeeded, lNeeded, lReturned If lReturned > 0 Then lJobCount = lReturned Else lJobCount = 0 End If Else lJobCount = 0 End If ClosePrinter hPrinter MsgBox "Jobs in printer queue: " + CStr(lJobCount), vbInformation End Sub
Visual Basic .NET example source code

C# example source code

Provide a code example

C#
VB.NET
VB6