InstanceDataCollection Class

Provides a strongly typed collection of InstanceData objects.

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

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

public class InstanceDataCollection : DictionaryBase

The InstanceDataCollection type exposes the following members.

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

  NameDescription
Public propertyCountGets the number of elements contained in the DictionaryBase instance. (Inherited from DictionaryBase.)
Public propertyCounterNameGets the name of the performance counter whose instance data you want to get.
Protected propertyDictionaryGets the list of elements contained in the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected propertyInnerHashtableGets the list of elements contained in the DictionaryBase instance. (Inherited from DictionaryBase.)
Public propertyItemGets the instance data associated with this counter. This is typically a set of raw counter values.
Public propertyKeysGets the object and counter registry keys for the objects associated with this instance data.
Public propertyValuesGets the raw counter values that comprise the instance data for the counter.
Top

  NameDescription
Public methodClearClears the contents of the DictionaryBase instance. (Inherited from DictionaryBase.)
Public methodContainsDetermines whether a performance instance with a specified name (identified by one of the indexed InstanceData objects) exists in the collection.
Public methodCopyTo(Array, Int32)Copies the DictionaryBase elements to a one-dimensional Array at the specified index. (Inherited from DictionaryBase.)
Public methodCopyTo(InstanceData[], Int32)Copies the items in the collection to the specified one-dimensional array at the specified index.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an IDictionaryEnumerator that iterates through the DictionaryBase instance. (Inherited from DictionaryBase.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnClearPerforms additional custom processes before clearing the contents of the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnClearCompletePerforms additional custom processes after clearing the contents of the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnGetGets the element with the specified key and value in the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnInsertPerforms additional custom processes before inserting a new element into the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnInsertCompletePerforms additional custom processes after inserting a new element into the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnRemovePerforms additional custom processes before removing an element from the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnRemoveCompletePerforms additional custom processes after removing an element from the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnSetPerforms additional custom processes before setting a value in the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnSetCompletePerforms additional custom processes after setting a value in the DictionaryBase instance. (Inherited from DictionaryBase.)
Protected methodOnValidatePerforms additional custom processes when validating the element with the specified key and value. (Inherited from DictionaryBase.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to a DictionaryBase object is synchronized (thread safe). (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to a DictionaryBase object. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIDictionary.AddAdds an element with the specified key and value into the DictionaryBase. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIDictionary.ContainsDetermines whether the DictionaryBase contains a specific key. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.IsFixedSizeGets a value indicating whether a DictionaryBase object has a fixed size. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.IsReadOnlyGets a value indicating whether a DictionaryBase object is read-only. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.ItemGets or sets the value associated with the specified key. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.KeysGets an ICollection object containing the keys in the DictionaryBase object. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIDictionary.RemoveRemoves the element with the specified key from the DictionaryBase. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate propertyIDictionary.ValuesGets an ICollection object containing the values in the DictionaryBase object. (Inherited from DictionaryBase.)
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorReturns an IEnumerator that iterates through the DictionaryBase. (Inherited from DictionaryBase.)
Top

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.

using System;
using System.Diagnostics;
using System.Collections;

class InstDataKeysValuesMod
{

    private static string categoryName;

    public static void Main()
    {
        string catNumStr;
        int categoryNum;

        PerformanceCounterCategory[] categories = PerformanceCounterCategory.GetCategories();

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

        int catX;
        for(catX=0; catX<categories.Length; catX++)
        {
            Console.WriteLine("{0,4} - {1}", catX+1, categories[catX].CategoryName);
        }

        // 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 = int.Parse(catNumStr);
            if (categoryNum<1||categoryNum>categories.Length)
            {
                throw new Exception(String.Format("The category number must be in the " +
                    "range 1..{0}.", categories.Length));
            }
            categoryName = categories[(categoryNum - 1)].CategoryName;

        }
        catch(Exception ex)
        {
            Console.WriteLine("\"{0}\" is not a valid category number." +
                "\r\n{1}", catNumStr, ex.Message);
            return;
        }

        // Process the InstanceDataCollectionCollection for this category.
        PerformanceCounterCategory pcc = new PerformanceCounterCategory(categoryName);
        InstanceDataCollectionCollection idColCol = pcc.ReadCategory();

        ICollection idColColKeys = idColCol.Keys;
        string[] idCCKeysArray = new string[idColColKeys.Count];
        idColColKeys.CopyTo(idCCKeysArray, 0);

        ICollection idColColValues = idColCol.Values;
        InstanceDataCollection[] idCCValuesArray = new InstanceDataCollection[idColColValues.Count];
        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. 
        int index;
        for(index=0; index<idCCKeysArray.Length; index++)
        {
            Console.WriteLine("  Next InstanceDataCollectionCollection " +
                "Key is \"{0}\"", idCCKeysArray[index]);
            ProcessInstanceDataCollection(idCCValuesArray[index]);
        }
    }

    // Display the contents of an InstanceDataCollection. 
    public static void ProcessInstanceDataCollection(InstanceDataCollection idCol)
    {

        ICollection idColKeys = idCol.Keys;
        string[] idColKeysArray = new string[idColKeys.Count];
        idColKeys.CopyTo(idColKeysArray, 0);

        ICollection idColValues = idCol.Values;
        InstanceData[] idColValuesArray = new InstanceData[idColValues.Count];
        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. 
        int index;
        for(index=0; index<idColKeysArray.Length; index++)
        {
            Console.WriteLine("    Next InstanceDataCollection " +
                "Key is \"{0}\"", idColKeysArray[index]);
            ProcessInstanceDataObject(idColValuesArray[index]);
        }
    }

    // Display the contents of an InstanceData object. 
    public static void ProcessInstanceDataObject(InstanceData instData)
    {
        CounterSample sample = instData.Sample;

        Console.WriteLine("    From InstanceData:\r\n      " +
            "InstanceName: {0,-31} RawValue: {1}", instData.InstanceName, instData.Sample.RawValue);
        Console.WriteLine("    From CounterSample:\r\n      " +
            "CounterType: {0,-32} SystemFrequency: {1}\r\n" +
            "      BaseValue: {2,-34} RawValue: {3}\r\n" +
            "      CounterFrequency: {4,-27} CounterTimeStamp: {5}\r\n" +
            "      TimeStamp: {6,-34} TimeStamp100nSec: {7}", sample.CounterType, sample.SystemFrequency, sample.BaseValue, sample.RawValue, sample.CounterFrequency, sample.CounterTimeStamp, sample.TimeStamp, sample.TimeStamp100nSec);
    }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft