IFsrmCommittableCollection.Commit Method (_FsrmCommitOptions)

 

Commits all the objects of the collection and returns the commit results for each object.

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

Syntax

IFsrmCollection Commit(
    _FsrmCommitOptions options
)

IFsrmCollection^ Commit(
    _FsrmCommitOptions options
)

abstract Commit : 
        options:_FsrmCommitOptions -> IFsrmCollection

Function Commit (
    options As _FsrmCommitOptions
) As IFsrmCollection

Parameters

• options
  Type: Microsoft.Storage._FsrmCommitOptions

  One or more options to use when committing the collection of objects. For possible values, see the _FsrmCommitOptions enumeration.

Return Value

Type: Microsoft.Storage.IFsrmCollection

A IFsrmCollection containing a collection of HRESULT values that correspond directly to the objects in the collection. The HRESULT value indicates the success or failure of committing the object.

Remarks

Committing objects in a batch operation provides better performance than committing each object in the collection individually (for example, calling the Commit method).

Note that the state of the objects in the collection must be the same. For example, the collection must contain all new objects, objects marked for deletion, or modified objects. The modified category covers objects that either are not new or are marked for deletion—the modified category does not necessarily mean that the objects have been modified.

A collection of imported objects would be considered a collection of modified objects. If you called the Delete method on an object, you would have to call the Remove method on the object to remove it from the collection before committing the collection.

See Also

IFsrmCommittableCollection Interface
Microsoft.Storage Namespace

Return to top