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_Tcpip_UDP class

The Win32_PerfFormattedData_Tcpip_UDT formatted data class provides pre-calculated data from performance counters that monitor the rates at which UDP datagrams are sent and received by using the UDP protocol. It includes counters that monitor UDP protocol errors.

This class is shown as the UDP object in System Monitor. This class derives its raw data from the corresponding raw class Win32_PerfRawData_Tcpip_UDP. The original data source is the Tcpip 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_Tcpip_UDP : Win32_PerfFormattedData
{
  string Caption;
  uint32 DatagramsNoPortPerSec;
  uint32 DatagramsPerSec;
  uint32 DatagramsReceivedErrors;
  uint32 DatagramsReceivedPerSec;
  uint32 DatagramsSentPerSec;
  string Description;
  uint64 Frequency_Object;
  uint64 Frequency_PerfTime;
  uint64 Frequency_Sys100NS;
  string Name;
  uint64 Timestamp_Object;
  uint64 Timestamp_PerfTime;
  uint64 Timestamp_Sys100NS;
};

Members

The Win32_PerfFormattedData_Tcpip_UDP class has these types of members:

Properties

The Win32_PerfFormattedData_Tcpip_UDP class has these properties.

Caption
Data type: string
Access type: Read-only

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

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

Rate of received UDP datagrams for which there was no application at the destination port.

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

Rate at which UDP datagrams are sent or received by the entity.

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

Number of received UDP datagrams that could not be delivered for reasons other than the lack of an application at the destination port.

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

Rate at which UDP datagrams are delivered to UDP users.

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

Rate at which UDP datagrams are sent from the entity.

Description
Data type: string
Access type: Read-only

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

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.

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.

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.

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