Share via


IFsrmCollection Interface

 

Defines a collection of FSRM objects.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

[GuidAttribute("F76FBF3B-8DDD-4B42-B05A-CB1C3FF1FEE8")]
public interface IFsrmCollection : IEnumerable
[GuidAttribute("F76FBF3B-8DDD-4B42-B05A-CB1C3FF1FEE8")]
public interface class IFsrmCollection : IEnumerable
[<GuidAttribute("F76FBF3B-8DDD-4B42-B05A-CB1C3FF1FEE8")>]
type IFsrmCollection = 
    interface
        interface IEnumerable
    end
<GuidAttribute("F76FBF3B-8DDD-4B42-B05A-CB1C3FF1FEE8")>
Public Interface IFsrmCollection
    Inherits IEnumerable

Properties

Name Description
System_CAPS_pubproperty Count

Retrieves the number of items in the collection.

System_CAPS_pubproperty Item[Int32]

Retrieves the requested item from the collection.

System_CAPS_pubproperty State

Retrieves the state of the collection.

Methods

Name Description
System_CAPS_pubmethod Cancel()

Cancels the collection of objects when the objects are collected asynchronously.

System_CAPS_pubmethod GetById(Guid)

Retrieves the specified object from the collection.

System_CAPS_pubmethod GetEnumerator()

Retrieves an enumerator that allows iteration through the collection of FSRM objects.

System_CAPS_pubmethod WaitForCompletion(Int32)

Limits the time that an asynchronous collection can take to collect the objects.

Remarks

The following methods and properties return this collection:

  1. Commit

  2. IFsrmDerivedObjectsResult

  3. results

  4. EnumActions

  5. ValueDefinitions

  6. EnumThresholdActions

  7. EnumReports

  8. EnumReportJobs

For an example that demonstrates this interface see Classifying Files.

See Also

Microsoft.Storage Namespace

Return to top