Export (0) Print
Expand All

EnumerationOptions Class

Provides a base class for query and enumeration-related options objects.

System.Object
  System.Management.ManagementOptions
    System.Management.EnumerationOptions

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

public class EnumerationOptions : ManagementOptions

The EnumerationOptions type exposes the following members.

  NameDescription
Public methodEnumerationOptions()Initializes a new instance of the EnumerationOptions class with default values (see the individual property descriptions for what the default values are). This is the default constructor.
Public methodEnumerationOptions(ManagementNamedValueCollection, TimeSpan, Int32, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)Initializes a new instance of the EnumerationOptions class to be used for queries or enumerations, allowing the user to specify values for the different options.
Top

  NameDescription
Public propertyBlockSizeGets or sets the block size for block operations. When enumerating through a collection, WMI will return results in groups of the specified size.
Public propertyContextGets or sets a WMI context object. This is a name-value pairs list to be passed through to a WMI provider that supports context information for customized operation. (Inherited from ManagementOptions.)
Public propertyDirectReadGets or sets a value indicating whether direct access to the WMI provider is requested for the specified class, without any regard to its super class or derived classes.
Public propertyEnsureLocatableGets or sets a value indicating whether to the objects returned should have locatable information in them. This ensures that the system properties, such as __PATH, __RELPATH, and __SERVER, are non-NULL. This flag can only be used in queries, and is ignored in enumerations.
Public propertyEnumerateDeepGets or sets a value indicating whether recursive enumeration is requested into all classes derived from the specified superclass. If false, only immediate derived class members are returned.
Public propertyPrototypeOnlyGets or sets a value indicating whether the query should return a prototype of the result set instead of the actual results. This flag is used for prototyping.
Public propertyReturnImmediatelyGets or sets a value indicating whether the invoked operation should be performed in a synchronous or semisynchronous fashion. If this property is set to true, the enumeration is invoked and the call returns immediately. The actual retrieval of the results will occur when the resulting collection is walked.
Public propertyRewindableGets or sets a value indicating whether the collection is assumed to be rewindable. If true, the objects in the collection will be kept available for multiple enumerations. If false, the collection can only be enumerated one time.
Public propertyTimeoutGets or sets the time-out to apply to the operation. Note that for operations that return collections, this time-out applies to the enumeration through the resulting collection, not the operation itself (the ReturnImmediately property is used for the latter). This property is used to indicate that the operation should be performed semi-synchronously. (Inherited from ManagementOptions.)
Public propertyUseAmendedQualifiersGets or sets a value indicating whether the objects returned from WMI should contain amended information. Typically, amended information is localizable information attached to the WMI object, such as object and property descriptions.
Top

  NameDescription
Public methodCloneReturns a copy of the object. (Overrides ManagementOptions.Clone().)
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 methodGetHashCodeServes as a hash function for a particular type. (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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The following example initializes an EnumerationOptions variable with an EnumerationOptions constructor and then gets all the instances of a WMI class and its subclasses.


using System;
using System.Management;
public class RemoteConnect 
{
    public static void Main() 
    {
        EnumerationOptions opt = new EnumerationOptions();
        // Will enumerate instances of the given class
        // and any subclasses.
        opt.EnumerateDeep = true;
        ManagementClass c = new ManagementClass("CIM_Service");
        foreach (ManagementObject o in c.GetInstances(opt))
            Console.WriteLine(o["Name"]);
    }
}


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.

Community Additions

ADD
Show:
© 2014 Microsoft