wmi Win32_PrintJob reference for Network Programming in .NET with C# & Visual Basic .NET (VB.NET)

WMI class ' Win32_PrintJob ' reference for C# and VB.NET

MOF Reference

[Description("The Win32_PrintJob class represents a print job generated by a Win32 application. Any unit of work generated by the Print command of an application running on a Win32 system is a descendent (or member) of this class.\nExample: A print document created by an Office 97 application"): ToSubClass, AMENDMENT, LOCALE(1033)]
class Win32_PrintJob : CIM_Job
{
	[Description("The Name property contains the name of the printer to which the print job is being spooled."): ToSubClass, key] string Name = NULL;
	[Description("User to be notified upon job completion or failure. This property is restricted to 16 characters under Windows 9x platforms."): ToSubClass] string Notify = NULL;
	[Description("The DataType property indicates the format of the data for this print job. This instructs the printer driver to eithertranslate the data (generic text, PostScript, or PCL) before printing, or to print in a raw format (for graphics and pictures).\nExample: TEXT"): ToSubClass] string DataType;
	[Description("The Document property specifies the name of the print job. The user sees this name when viewing documents waiting to be printed. \nExample: Microsoft Word - Review.doc"): ToSubClass] string Document;
	[Description("The DriverName property indicates the name of the printer driver used for the print job."): ToSubClass] string DriverName;
	[Description("The HostPrintQueue property contains the name of the computer on which the print job was created."): ToSubClass] string HostPrintQueue;
	[Description("The JobId property indicates the identifier number of the job. It is used by other methods as a handle to a single job spooling to the printer."): ToSubClass] uint32 JobId;
	[Description("The PagesPrinted property specifies the number of pages that have been printed. This value may be zero if the print job does not contain page delimiting information."): ToSubClass] uint32 PagesPrinted;
	[Description("The Parameters property indicates optional parameters to send to the print processor. See the PrintProcessor member for more information."): ToSubClass] string Parameters;
	[Description("The PrintProcessor property indicates the print processor service used to process the print job. A printer processor works in conjunction with the printer driver to provide additional translation of printer data for the printer, and can also be used to provide special options such as a title page for the job."): ToSubClass] string PrintProcessor;
	[Description("The Size property indicates the size of the print job."): ToSubClass] uint32 Size;
	[Description("The StatusMask property specifies a bitmap of the possible statuses relating to this print job."): ToSubClass, BitValues{"Paused", "Error", "Deleting", "Spooling", "Printing", "Offline", "Paperout", "Printed", "Deleted", "Blocked_DevQ", "User_Intervention_Req", "Restart"}: ToSubClass] uint32 StatusMask;
	[Description("The TotalPages property specifies the number of pages required to complete the job. This value may be zero if the print job does not contain page-delimiting information."): ToSubClass] uint32 TotalPages;
	[Description("The Pause method pauses a job in a print queue. If the job was currently printing, no other job will be printed. If the job wasn't printing yet, another unpaused print job may begin printing. The method can return the following values:\n0 - Success.\n5 - Access denied.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Other"}: ToSubClass] uint32 Pause();
	[Description("The Resume method continues a paused print job. The method can return the following values:\n0 - Success.\n5 - Access denied.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Other"}: ToSubClass] uint32 Resume();
};

Class properties:

Win32_PrintJob.Caption
Win32_PrintJob.DataType
Win32_PrintJob.Description
Win32_PrintJob.Document
Win32_PrintJob.DriverName
Win32_PrintJob.ElapsedTime
Win32_PrintJob.HostPrintQueue
Win32_PrintJob.InstallDate
Win32_PrintJob.JobId
Win32_PrintJob.JobStatus
Win32_PrintJob.Name
Win32_PrintJob.Notify
Win32_PrintJob.Owner
Win32_PrintJob.PagesPrinted
Win32_PrintJob.Parameters
Win32_PrintJob.PrintProcessor
Win32_PrintJob.Priority
Win32_PrintJob.Size
Win32_PrintJob.StartTime
Win32_PrintJob.Status
Win32_PrintJob.StatusMask
Win32_PrintJob.TimeSubmitted
Win32_PrintJob.TotalPages
Win32_PrintJob.UntilTime

WMI is a huge subject, so therefore it is practically impossible to provide a comprehensive example program that covers anything. However, the book “Network programming in .NET” (Buy at Amazon UK) (Buy at Amazon US) covers a much wider scope of WMI, and explains how to leverage it to access the bounty of information held within this vast, yet simple object model.

Articles

Contact us

Please use FireFox to view this page

WMI class ' Win32_PrintJob ' reference for C# and VB.NET

MOF Reference

Class properties: