IFsrmStorageModuleDefinition Interface

 

Defines a local storage module that is used to read and write property values.

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

Syntax

[GuidAttribute("15A81350-497D-4ABA-80E9-D4DBCC5521FE")]
public interface IFsrmStorageModuleDefinition : IFsrmPipelineModuleDefinition
[GuidAttribute("15A81350-497D-4ABA-80E9-D4DBCC5521FE")]
public interface class IFsrmStorageModuleDefinition : IFsrmPipelineModuleDefinition
[<GuidAttribute("15A81350-497D-4ABA-80E9-D4DBCC5521FE")>]
type IFsrmStorageModuleDefinition = 
    interface
        interface IFsrmPipelineModuleDefinition
    end
<GuidAttribute("15A81350-497D-4ABA-80E9-D4DBCC5521FE")>
Public Interface IFsrmStorageModuleDefinition
    Inherits IFsrmPipelineModuleDefinition

Properties

Name Description
System_CAPS_pubproperty Account

Gets and sets the account to use when running the module.

System_CAPS_pubproperty Capabilities

Flags that specify capabilities of the storage module.

This property is read/write.

System_CAPS_pubproperty Company

Gets and sets the name of the company that created the classification or storage module. 

System_CAPS_pubproperty Description

Gets and sets the Description property.

System_CAPS_pubproperty Enabled

Determines whether the module is enabled.

System_CAPS_pubproperty id

Gets the id property.

System_CAPS_pubproperty ModuleClsid

Retrieves or sets a string representation specifying the COM class identifier for the class that implements the module defined by this module definition.

System_CAPS_pubproperty ModuleType

Retrieves the type of module.

System_CAPS_pubproperty Name

Retrieves or sets the name of the module definition.

System_CAPS_pubproperty NeedsFileContent

Gets or sets a value that determines whether the module needs to read the contents of the file.

System_CAPS_pubproperty Parameters

Retrieves or sets the optional parameters to pass to the module.

System_CAPS_pubproperty StorageType

The type of storage that the storage module uses.

System_CAPS_pubproperty SupportedExtensions

Retrieves or sets the list of file extensions supported by this module.

System_CAPS_pubproperty UpdatesFileContent

Determines whether the module updates the contents of the file.

System_CAPS_pubproperty Version

Retrieves or sets the version of the module definition.

Methods

Name Description
System_CAPS_pubmethod Commit()

Saves the module object in the server's list of objects.

System_CAPS_pubmethod Delete()

Removes the module object from the server's list of objects.

Remarks

Important

This interface supports local use only. Remote operations are not supported.

To create a storage module definition, call the CreateModuleDefinition method.

The following methods can return this interface:

  1. EnumModuleDefinitions

  2. GetModuleDefinition

See Also

Microsoft.Storage Namespace

Return to top