IFsrmPropertyBag2.GetFileStreamInterface Method (_FsrmFileStreamingMode, _FsrmFileStreamingInterfaceType)

Article
10/10/2016

Retrieves a file stream interface that you can use to access the contents of the file.

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

Syntax

object GetFileStreamInterface(
    _FsrmFileStreamingMode accessMode,
    _FsrmFileStreamingInterfaceType interfaceType
)

Object^ GetFileStreamInterface(
    _FsrmFileStreamingMode accessMode,
    _FsrmFileStreamingInterfaceType interfaceType
)

abstract GetFileStreamInterface : 
        accessMode:_FsrmFileStreamingMode *
        interfaceType:_FsrmFileStreamingInterfaceType -> Object

Function GetFileStreamInterface (
    accessMode As _FsrmFileStreamingMode,
    interfaceType As _FsrmFileStreamingInterfaceType
) As Object

Parameters

accessMode
Type: Microsoft.Storage._FsrmFileStreamingMode

One or more access modes. For possible values, see the _FsrmFileStreamingMode enumeration.

interfaceType
Type: Microsoft.Storage._FsrmFileStreamingInterfaceType

The type of streaming interface to use. For possible interface types, see the _FsrmFileStreamingInterfaceType enumeration.

Return Value

Type: System.Object

Returns a Object containing a VARIANT that contains the streaming interface that you can use to access the contents of the file. The variant is of type VT_DISPATCH. Query the dispval member of the variant to get the specified streaming interface.

Implements

IFsrmPropertyBag.GetFileStreamInterface(_FsrmFileStreamingMode, _FsrmFileStreamingInterfaceType)

Remarks

To ensure the caller can be authorized for access, it must be a module that has its NeedsFileContent property set to TRUE. If the accessMode parameter is set to FsrmFileStreamingMode_Write, the caller must also be a storage module and have its UpdatesFileContent property set to TRUE.

Share via