InstanceDataCollection Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides a strongly typed collection of InstanceData objects.

Namespace:   System.Diagnostics
Assembly:  System (in System.dll)

System.Object
  System.Collections.DictionaryBase
    System.Diagnostics.InstanceDataCollection

Public Class InstanceDataCollection
	Inherits DictionaryBase

NameDescription
System_CAPS_pubmethodInstanceDataCollection(String)

Obsolete. Initializes a new instance of the InstanceDataCollection class, using the specified performance counter (which defines a performance instance).

NameDescription
System_CAPS_pubpropertyCount

Gets the number of elements contained in the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_pubpropertyCounterName

Gets the name of the performance counter whose instance data you want to get.

System_CAPS_protpropertyDictionary

Gets the list of elements contained in the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protpropertyInnerHashtable

Gets the list of elements contained in the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_pubpropertyItem(String)

Gets the instance data associated with this counter. This is typically a set of raw counter values.

System_CAPS_pubpropertyKeys

Gets the object and counter registry keys for the objects associated with this instance data.

System_CAPS_pubpropertyValues

Gets the raw counter values that comprise the instance data for the counter.

NameDescription
System_CAPS_pubmethodClear()

Clears the contents of the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_pubmethodContains(String)

Determines whether a performance instance with a specified name (identified by one of the indexed InstanceData objects) exists in the collection.

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies the DictionaryBase elements to a one-dimensional Array at the specified index.(Inherited from DictionaryBase.)

System_CAPS_pubmethodCopyTo(InstanceData(), Int32)

Copies the items in the collection to the specified one-dimensional array at the specified index.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an IDictionaryEnumerator that iterates through the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnClear()

Performs additional custom processes before clearing the contents of the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnClearComplete()

Performs additional custom processes after clearing the contents of the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnGet(Object, Object)

Gets the element with the specified key and value in the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnInsert(Object, Object)

Performs additional custom processes before inserting a new element into the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnInsertComplete(Object, Object)

Performs additional custom processes after inserting a new element into the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnRemove(Object, Object)

Performs additional custom processes before removing an element from the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnRemoveComplete(Object, Object)

Performs additional custom processes after removing an element from the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnSet(Object, Object, Object)

Performs additional custom processes before setting a value in the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnSetComplete(Object, Object, Object)

Performs additional custom processes after setting a value in the DictionaryBase instance.(Inherited from DictionaryBase.)

System_CAPS_protmethodOnValidate(Object, Object)

Performs additional custom processes when validating the element with the specified key and value.(Inherited from DictionaryBase.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.Add(Object, Object)

Adds an element with the specified key and value into the DictionaryBase.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.Contains(Object)

Determines whether the DictionaryBase contains a specific key.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.Remove(Object)

Removes the element with the specified key from the DictionaryBase.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Returns an IEnumerator that iterates through the DictionaryBase.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

Gets a value indicating whether access to a DictionaryBase object is synchronized (thread safe).(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

Gets an object that can be used to synchronize access to a DictionaryBase object.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.IsFixedSize

Gets a value indicating whether a DictionaryBase object has a fixed size.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.IsReadOnly

Gets a value indicating whether a DictionaryBase object is read-only.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.Item(Object)

Gets or sets the value associated with the specified key.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.Keys

Gets an ICollection object containing the keys in the DictionaryBase object.(Inherited from DictionaryBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.Values

Gets an ICollection object containing the values in the DictionaryBase object.(Inherited from DictionaryBase.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast(Of TResult)()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType(Of TResult)()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

The InstanceDataCollection class represents a collection containing all the instance data for a counter. This collection is contained in the InstanceDataCollectionCollection when using the ReadCategory method.

The following code example displays the instance data for a particular PerformanceCounterCategory on the local computer. It first displays a numbered list of PerformanceCounterCategory names. After the user enters the number of one of the categories, the example gets the InstanceDataCollectionCollection for that PerformanceCounterCategory. It then converts the collection returned by Values to an array of InstanceDataCollection objects. The example also displays the instance data associated with each InstanceData of each InstanceDataCollection.

Imports System
Imports System.Diagnostics
Imports System.Collections
Imports Microsoft.VisualBasic

Module InstDataKeysValuesMod

    Private categoryName As String

    Sub Main()
        Dim catNumStr As String
        Dim categoryNum As Integer

        Dim categories As PerformanceCounterCategory() = _
            PerformanceCounterCategory.GetCategories()

        Console.WriteLine( _
            "These categories are registered on this computer:")

        Dim catX As Integer
        For catX = 0 To categories.Length - 1
            Console.WriteLine("{0,4} - {1}", catX + 1, _
                categories(catX).CategoryName)
        Next catX

        ' Ask the user to choose a category.
        Console.Write( _
            "Enter the category number from the above list: ")
        catNumStr = Console.ReadLine()

        ' Validate the entered category number.
        Try
            categoryNum = Integer.Parse(catNumStr)
            If categoryNum < 1 Or categoryNum > categories.Length Then
                Throw New Exception( _
                    String.Format("The category number must be in the " & _
                        "range 1..{0}.", categories.Length))
            End If
            categoryName = categories((categoryNum - 1)).CategoryName

        Catch ex As Exception
            Console.WriteLine("""{0}"" is not a valid category number." & _
                vbCrLf & "{1}", catNumStr, ex.Message)
            Return
        End Try

        ' Process the InstanceDataCollectionCollection for this category.
        Dim pcc As New PerformanceCounterCategory(categoryName)
        Dim idColCol As InstanceDataCollectionCollection = pcc.ReadCategory()

        Dim idColColKeys As ICollection = idColCol.Keys
        Dim idCCKeysArray(idColColKeys.Count - 1) As String
        idColColKeys.CopyTo(idCCKeysArray, 0)

        Dim idColColValues As ICollection = idColCol.Values
        Dim idCCValuesArray(idColColValues.Count - 1) As InstanceDataCollection
        idColColValues.CopyTo(idCCValuesArray, 0)

        Console.WriteLine("InstanceDataCollectionCollection for ""{0}"" " & _
            "has {1} elements.", categoryName, idColCol.Count)

        ' Display the InstanceDataCollectionCollection Keys and Values.
        ' The Keys and Values collections have the same number of elements.
        Dim index As Integer
        For index = 0 To idCCKeysArray.Length - 1
            Console.WriteLine("  Next InstanceDataCollectionCollection " & _
                "Key is ""{0}""", idCCKeysArray(index))
            ProcessInstanceDataCollection(idCCValuesArray(index))
        Next index
    End Sub

    ' Display the contents of an InstanceDataCollection.
    Sub ProcessInstanceDataCollection(ByVal idCol As InstanceDataCollection)

        Dim idColKeys As ICollection = idCol.Keys
        Dim idColKeysArray(idColKeys.Count - 1) As String
        idColKeys.CopyTo(idColKeysArray, 0)

        Dim idColValues As ICollection = idCol.Values
        Dim idColValuesArray(idColValues.Count - 1) As InstanceData
        idColValues.CopyTo(idColValuesArray, 0)

        Console.WriteLine("  InstanceDataCollection for ""{0}"" " & _
            "has {1} elements.", idCol.CounterName, idCol.Count)

        ' Display the InstanceDataCollection Keys and Values.
        ' The Keys and Values collections have the same number of elements.
        Dim index As Integer
        For index = 0 To idColKeysArray.Length - 1
            Console.WriteLine("    Next InstanceDataCollection " & _
                "Key is ""{0}""", idColKeysArray(index))
            ProcessInstanceDataObject(idColValuesArray(index))
        Next index
    End Sub

    ' Display the contents of an InstanceData object.
    Sub ProcessInstanceDataObject(ByVal instData As InstanceData)
        Dim sample As CounterSample = instData.Sample

        Console.WriteLine("    From InstanceData:" & vbCrLf & "      " & _
            "InstanceName: {0,-31} RawValue: {1}", _
            instData.InstanceName, instData.Sample.RawValue)
        Console.WriteLine("    From CounterSample:" & vbCrLf & "      " & _
            "CounterType: {0,-32} SystemFrequency: {1}" & vbCrLf & _
            "      BaseValue: {2,-34} RawValue: {3}" & vbCrLf & _
            "      CounterFrequency: {4,-27} CounterTimeStamp: {5}" & vbCrLf & _
            "      TimeStamp: {6,-34} TimeStamp100nSec: {7}", _
            sample.CounterType, sample.SystemFrequency, sample.BaseValue, _
            sample.RawValue, sample.CounterFrequency, sample.CounterTimeStamp, _
            sample.TimeStamp, sample.TimeStamp100nSec)
    End Sub
End Module

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: