Win32_PrintJob, ROOT\CIMV2

Class | Methods (2) | Properties (29) | Qualifiers (7) | Instances | Namespaces (1)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

CIM_Job is a logical element representing a unit of work for a system, such as a print job. A job is distinct from a process in that a job can be scheduled.

Win32_PrintJob methods

Win32_PrintJob has 2 methods (2 Local)

NameOriginReturn
PauseWin32_PrintJobuint32 {'out':True}
ResumeWin32_PrintJobuint32 {'out':True}

Win32_PrintJob properties

Win32_PrintJob has 29 properties (16 Local, 13 Derived)

NameOriginCIMType
CaptionCIM_ManagedSystemElement8 [string]
ColorWin32_PrintJob8 [string]
DataTypeWin32_PrintJob8 [string]
DescriptionCIM_ManagedSystemElement8 [string]
DocumentWin32_PrintJob8 [string]
DriverNameWin32_PrintJob8 [string]
ElapsedTimeCIM_Job101 [datetime]
HostPrintQueueWin32_PrintJob8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
JobIdWin32_PrintJob19 [uint32]
JobStatusCIM_Job8 [string]
key
Name
CIM_ManagedSystemElement8 [string]
NotifyCIM_Job8 [string]
OwnerCIM_Job8 [string]
PagesPrintedWin32_PrintJob19 [uint32]
PaperLengthWin32_PrintJob19 [uint32]
PaperSizeWin32_PrintJob8 [string]
PaperWidthWin32_PrintJob19 [uint32]
ParametersWin32_PrintJob8 [string]
PrintProcessorWin32_PrintJob8 [string]
PriorityCIM_Job19 [uint32]
SizeWin32_PrintJob19 [uint32]
SizeHighWin32_PrintJob19 [uint32]
StartTimeCIM_Job101 [datetime]
StatusCIM_ManagedSystemElement8 [string]
StatusMaskWin32_PrintJob19 [uint32]
TimeSubmittedCIM_Job101 [datetime]
TotalPagesWin32_PrintJob19 [uint32]
UntilTimeCIM_Job101 [datetime]

Detailed description of Win32_PrintJob methods

Local methods (2) of Win32_PrintJob class

Pause method
Returnuint32 {'out':True}
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:
0 - Success.
5 - Access denied.
Other - For integer values other than those listed above, refer to the documentation on the Win32 error codes.'
ImplementedTrue
ValueMap['0', '5', '..']
Values['Success', 'Access denied', 'Other']
Pause method is in 2 classes of ROOT\cimv2 and in 2 namespaces
Resume method
Returnuint32 {'out':True}
Description'The Resume method continues a paused print job. The method can return the following values:
0 - Success.
5 - Access denied.
Other - For integer values other than those listed above, refer to the documentation on the Win32 error codes.'
ImplementedTrue
ValueMap['0', '5', '..']
Values['Success', 'Access denied', 'Other']
Resume method is in 3 classes of ROOT\cimv2 and in 6 namespaces

Detailed description of Win32_PrintJob properties

Local properties (16) of Win32_PrintJob class

Color property
CIMTYPE'string'
Description'The Color property indicates whether the document is to be printed in color or monochrome. Some color printers have the capability to print using true black instead of a combination of Yellow, Cyan, and Magenta. This usually creates darker and sharper text for documents. This option is only useful for color printers that support true black printing.'
MappingStrings['Win32API|Printing and Print Spooler Structures|DEVMODE|dmColor']
readTrue
Color property is in 2 classes of ROOT\cimv2 and in 3 namespaces
DataType property
CIMTYPE'string'
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).
Example: TEXT'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|pDatatype']
readTrue
DataType property is in 1 class (Win32_PrintJob) of ROOT\cimv2 and in 6 namespaces
Document property
CIMTYPE'string'
Description'The Document property specifies the name of the print job. The user sees this name when viewing documents waiting to be printed.
Example: Microsoft Word - Review.doc'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|pDocument']
readTrue
Document property is in 1 class (Win32_PrintJob) of ROOT\cimv2 and in 1 namespace
DriverName property
CIMTYPE'string'
Description'The DriverName property indicates the name of the printer driver used for the print job.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|pDriverName']
readTrue
DriverName property is in 4 classes of ROOT\cimv2 and in 7 namespaces
HostPrintQueue property
CIMTYPE'string'
Description'The HostPrintQueue property contains the name of the computer on which the print job was created.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|pMachineName']
readTrue
HostPrintQueue property is in 1 class (Win32_PrintJob) of ROOT\cimv2 and in 1 namespace
JobId property
CIMTYPE'uint32'
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.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|JobId']
readTrue
JobId property is in 2 classes of ROOT\cimv2 and in 2 namespaces
PagesPrinted property
CIMTYPE'uint32'
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.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|PagesPrinted']
readTrue
PagesPrinted property is in 1 class (Win32_PrintJob) of ROOT\cimv2 and in 3 namespaces
PaperLength property
CIMTYPE'uint32'
Description'The PaperLength property indicates the length of the paper.
Example: 2794'
MappingStrings['Win32API|Printing and Print Spooler Structures|DEVMODE|dmPaperLength']
readTrue
Units'tenths of a millimeter'
PaperLength property is in 2 classes of ROOT\cimv2 and in 1 namespace
PaperSize property
CIMTYPE'string'
Description'The PaperSize property indicates the size of the paper.
Example: A4 or Letter'
MappingStrings['Win32API|Printing and Print Spooler Structures|DEVMODE|dmPaperSize']
readTrue
PaperSize property is in 2 classes of ROOT\cimv2 and in 3 namespaces
PaperWidth property
CIMTYPE'uint32'
Description'The PaperWidth property indicates the width of the paper.
Example: 2159'
MappingStrings['Win32API|Printing and Print Spooler Structures|DEVMODE|dmPaperWidth ']
readTrue
Units'tenths of a millimeter'
PaperWidth property is in 2 classes of ROOT\cimv2 and in 1 namespace
Parameters property
CIMTYPE'string'
Description'The Parameters property indicates optional parameters to send to the print processor. See the PrintProcessor member for more information.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|pParameters ']
readTrue
Parameters property is in 4 classes of ROOT\cimv2 and in 142 namespaces
PrintProcessor property
CIMTYPE'string'
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.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|pPrintProcessor']
readTrue
PrintProcessor property is in 2 classes of ROOT\cimv2 and in 3 namespaces
Size property
CIMTYPE'uint32'
Description'The Size property indicates the size of the print job.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|Size']
readTrue
Units'bytes'
Size property is in 10 classes of ROOT\cimv2 and in 16 namespaces
SizeHigh property
CIMTYPE'uint32'
Description'The SizeHigh property indicates the size of the print job if the Size property exceeds 4,294,967,295 bytes.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|SizeHigh']
readTrue
Units'bytes'
SizeHigh property is in 1 class (Win32_PrintJob) of ROOT\cimv2 and in 1 namespace
StatusMask property
BitValues['Paused', 'Error', 'Deleting', 'Spooling', 'Printing', 'Offline', 'Paperout', 'Printed', 'Deleted', 'Blocked_DevQ', 'User_Intervention_Req', 'Restart']
CIMTYPE'uint32'
Description'The StatusMask property specifies a bitmap of the possible statuses relating to this print job.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|Status']
readTrue
StatusMask property is in 1 class (Win32_PrintJob) of ROOT\cimv2 and in 3 namespaces
TotalPages property
CIMTYPE'uint32'
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.'
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|TotalPages']
readTrue
TotalPages property is in 5 classes of ROOT\cimv2 and in 3 namespaces

Derived properties (13) of Win32_PrintJob class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one-line string) of the object.'
MaxLen64
readTrue
Caption property is in 1050 classes of ROOT\cimv2 and in 37 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object. '
readTrue
Description property is in 1061 classes of ROOT\cimv2 and in 142 namespaces
ElapsedTime property
CIMTYPE'datetime'
Description'Length of time that the job has been executing.'
readTrue
ElapsedTime property is in 10 classes of ROOT\cimv2 and in 17 namespaces
InstallDate property
CIMTYPE'datetime'
Description'The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
MappingStrings['MIF.DMTF|ComponentID|001.5']
readTrue
InstallDate property is in 227 classes of ROOT\cimv2 and in 23 namespaces
JobStatus property
CIMTYPE'string'
Description'A free form string representing the job's status.'
readTrue
JobStatus property is in 3 classes of ROOT\cimv2 and in 15 namespaces
Name property
CIMTYPE'string'
Description'The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.'
keyTrue
MappingStrings['Win32API|Printing and Print Spooler Structures|JOB_INFO_4|pPrinterName']
Override'Name'
readTrue
Name property is in 1046 classes of ROOT\cimv2 and in 142 namespaces
Notify property
CIMTYPE'string'
Description'User to be notified upon job completion or failure. This property is restricted to 16 characters under Windows 9x platforms.'
Override'Notify'
readTrue
Notify property is in 3 classes of ROOT\cimv2 and in 13 namespaces
Owner property
CIMTYPE'string'
Description'User that submitted the job.'
readTrue
Owner property is in 7 classes of ROOT\cimv2 and in 142 namespaces
Priority property
CIMTYPE'uint32'
Description'Priority indicates the urgency or importance of execution of a job.'
readTrue
Priority property is in 9 classes of ROOT\cimv2 and in 31 namespaces
StartTime property
CIMTYPE'datetime'
Description'Time that the job was begun.'
readTrue
StartTime property is in 6 classes of ROOT\cimv2 and in 24 namespaces
Status property
CIMTYPE'string'
Description'The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "Starting", "Stopping" and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.'
MaxLen10
readTrue
ValueMap['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service', 'Stressed', 'NonRecover', 'No Contact', 'Lost Comm']
Values['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service', 'Stressed', 'NonRecover', 'No Contact', 'Lost Comm']
Status property is in 230 classes of ROOT\cimv2 and in 42 namespaces
TimeSubmitted property
CIMTYPE'datetime'
Description'Time that the job was submitted.'
readTrue
TimeSubmitted property is in 3 classes of ROOT\cimv2 and in 15 namespaces
UntilTime property
CIMTYPE'datetime'
Description'Time after which the job is invalid or should be stopped.'
readTrue
UntilTime property is in 4 classes of ROOT\cimv2 and in 10 namespaces

Win32_PrintJob Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
DeleteBy'DeleteInstance'
Description'CIM_Job is a logical element representing a unit of work for a system, such as a print job. A job is distinct from a process in that a job can be scheduled.'
dynamicTrue
Locale1033
provider'CIMWin32'
SupportsDeleteTrue
UUID'{8502C4DF-5FBB-11D2-AAC1-006008C78BC7}'

Win32_PrintJob System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\cimv2:Win32_PrintJob'___SYSTEM8
__NAMESPACE'ROOT\cimv2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Job', 'CIM_LogicalElement', 'CIM_ManagedSystemElement']___SYSTEM8
__PROPERTY_COUNT29___SYSTEM3
__RELPATH'Win32_PrintJob'___SYSTEM8
__DYNASTY'CIM_ManagedSystemElement'___SYSTEM8
__SUPERCLASS'CIM_Job'___SYSTEM8
__CLASS'Win32_PrintJob'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to Win32_PrintJob

Number of classes:24
comments powered by Disqus
WUtils.com