Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Win32_PerfFormattedData_Spooler_PrintQueue class

The Win32_PerfFormattedData_Spooler_PrintQueue formatted data class provides pre-calculated data from performance counters that monitor a print queue.

This class represents the Print Queue object in System Monitor and returns the same data found in System Monitor. This class derives its raw data from the corresponding raw class Win32_PerfRawData_Spooler_PrintQueue. The original data source is the PerfNet performance library. Data is dynamically provided for this class from the performance library object by the WmiPerfInst provider.

Windows Server 2003 and Windows XP:  WMI data for this class is supplied by the Formatted Performance Data Provider.

The following syntax is simplified from MOF code and shows all inherited properties, including the Frequency and Timestamp properties required for class display in System Monitor. For more information about required property qualifiers, see Property Qualifiers for Performance Counter Classes. For more information about CounterType values, see WMI Performance Counter Types.

Syntax

class Win32_PerfFormattedData_Spooler_PrintQueue : Win32_PerfFormattedData
{
  uint32 AddNetworkPrinterCalls;
  uint64 BytesPrintedPerSec;
  string Caption;
  string Description;
  uint32 EnumerateNetworkPrinterCalls;
  uint64 Frequency_Object;
  uint64 Frequency_PerfTime;
  uint64 Frequency_Sys100NS;
  uint32 JobErrors;
  uint32 Jobs;
  uint32 JobsSpooling;
  uint32 MaxJobsSpooling;
  uint32 MaxReferences;
  string Name;
  uint32 NotReadyErrors;
  uint32 OutOfPaperErrors;
  uint32 References;
  uint64 Timestamp_Object;
  uint64 Timestamp_PerfTime;
  uint64 Timestamp_Sys100NS;
  uint32 TotalJobsPrinted;
  uint32 TotalPagesPrinted;
};

Members

The Win32_PerfFormattedData_Spooler_PrintQueue class has these types of members:

Properties

The Win32_PerfFormattedData_Spooler_PrintQueue class has these properties.

AddNetworkPrinterCalls
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("AddNetworkPrinterCalls") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of calls from other print servers to add shared network printers to this server after the last restart.

BytesPrintedPerSec
Data type: uint64
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_BULK_COUNT") , Counter ("BytesPrintedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of bytes per second printed on a print queue.

For more information about using uint64 values in scripts, see Scripting in WMI.

Caption
Data type: string
Access type: Read-only

Short textual description for the statistic or metric. This property is inherited from CIM_StatisticalInformation.

Description
Data type: string
Access type: Read-only

Textual description of the statistic or metric. This property is inherited from CIM_StatisticalInformation.

EnumerateNetworkPrinterCalls
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("EnumerateNetworkPrinterCalls") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of calls from browse clients to this print server to request network browse lists after the last restart.

Frequency_Object
Data type: uint64
Access type: Read-only

Frequency, in ticks per second, of Timestamp_Object. This property is defined by the provider. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Frequency_PerfTime
Data type: uint64
Access type: Read-only

Frequency, in ticks per second, of Timestamp_Perftime. A value could be obtained by calling the Windows function QueryPerformanceCounter. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Frequency_Sys100NS
Data type: uint64
Access type: Read-only

Frequency, in ticks per second, of Timestamp_Sys100NS (10000000). This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

JobErrors
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("JobErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of job errors in a print queue after the last restart.

Jobs
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("Jobs") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Current number of jobs in a print queue.

JobsSpooling
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("JobsSpooling") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Current number of spooling jobs in a print queue.

MaxJobsSpooling
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("MaxJobsSpooling") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Maximum number of spooling jobs in a print queue after the last restart.

MaxReferences
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("MaxReferences") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Maximum number of references to a print queue after the last restart.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Label by which the statistic or metric is known. When sub-classed, the property can be overridden to be a key property. This property is inherited from CIM_StatisticalInformation.

NotReadyErrors
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("NotReadyErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of printer-not-ready errors in a print queue after the last restart.

OutOfPaperErrors
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("OutofPaperErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of out-of-paper errors in a print queue after the last restart.

References
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("References") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Current number of references to a print queue.

Timestamp_Object
Data type: uint64
Access type: Read-only

Object-defined timestamp, defined by the provider. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Timestamp_PerfTime
Data type: uint64
Access type: Read-only

High Performance counter timestamp. A value could be obtained by calling the Windows function QueryPerformanceCounter. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Timestamp_Sys100NS
Data type: uint64
Access type: Read-only

Timestamp value in 100 nanosecond units. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

TotalJobsPrinted
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("TotalJobsPrinted") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of jobs printed on a print queue after the last restart.

TotalPagesPrinted
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("TotalPagesPrinted") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of pages printed through GDI on a print queue after the last restart.

Remarks

All classes derived from Win32_Perf are designed to be used with a refresher object. For more information about how to create and use a refresher object in C++, see Accessing Performance Data in C++. For more information about how to create and use a refresher object using scripts, see Refreshing WMI Data in Scripts.

The performance class and property qualifiers determine how to interpret the class data. For more information, see Class Qualifiers for Performance Counter Classes and Property Qualifiers for Performance Counter Classes.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

DLL

WmiPerfInst.dll;
WmiCookr.dll on Windows Server 2003 and Windows XP

See also

Performance Counter Classes
Accessing WMI Preinstalled Performance Classes
WMI Tasks: Performance Monitoring
Accessing Performance Data in Script

 

 

Show:
© 2014 Microsoft