BLACKICE_JOBINFO Structure

The BLACKICE_JOBINFO structure is used by the GetJobInfo function to retrieve data about the print job.


typedef struct _BLACKICE_JOBINFO

{

            DWORD                    dwJobID;

            DWORD                    dwTotalJobs;  // reserved, not returned by GetJobInfo

            TCHAR                      szPrinterName[MAX_PATH];  // reserved, not returned by GetJobInfo

            TCHAR                      szMachineName[MAX_PATH];

            TCHAR                      szUserName[MAX_PATH];

            TCHAR                      szDocument[MAX_PATH];

            TCHAR                      szStatus[MAX_PATH];

            DWORD                    dwStatus;

            DWORD                    dwPriority;

            DWORD                    dwPosition;

            DWORD                    dwTotalPages;

            DWORD                    dwPagesPrinted;

            SYSTEMTIME          stSubmitted;

}BLACKICE_JOBINFO, *PBLACKICE_JOBINFO;

 

The members of the BLACKICE_JOBINFO structure holds the following information:

 

dwJobID

The ID of the print job

dwTotalJobs

Reserved, not returned by GetJobInfo

szPrinterName

Reserved, not returned by GetJobInfo

szMachineName

The name of the machine that generated the job

szUserName

The user who printed the job

szDocument

The name of the printed document,. The name of the document is set by the printing application and it may not be the name of the printed file

szStatus

String describing the status of the printing. If it is empty, check the dwStatus member for status information.

dwStatus

The status of the printing. Can be a combination of the following values:

Status code

Value

JOB_STATUS_PAUSED

0x00000001

JOB_STATUS_ERROR               

0x00000002

JOB_STATUS_DELETING            

0x00000004

JOB_STATUS_SPOOLING            

0x00000008

JOB_STATUS_PRINTING            

0x00000010

JOB_STATUS_OFFLINE             

0x00000020

JOB_STATUS_PAPEROUT            

0x00000040

JOB_STATUS_PRINTED             

0x00000080

JOB_STATUS_DELETED             

0x00000100

JOB_STATUS_BLOCKED_DEVQ        

0x00000200

JOB_STATUS_USER_INTERVENTION  

0x00000400

JOB_STATUS_RESTART             

0x00000800

dwPriority

The job priority. This member can be in the range between 1 through 99

dwPosition

The position of the job in the print queue. It is different from the Job ID.

dwTotalPages

Number of pages remaining to be printed

dwPagesPrinted

Number of total pages already printed

stSubmitted

The time the job was submitted, in SYSTEMTIME format.

 

Notes:

The value returned of the dwStatus of BLACKICE_JOBINFO structure can be a combination of multiple values.

The Black Ice functions use the Microsoft JOB_INFO_1 structure internally.

For an up to date list of the possible return values please see the following Microsoft page:

http://msdn.microsoft.com/en-us/library/windows/desktop/dd145019(v=vs.85).aspx

0x00002010 is a combination of the JOB_STATUS_RETAINED (0x00002000) and JOB_STATUS_PRINTING (0x00000010) flags.