FileStreamStorage<TKey> Class

Visual Studio 2015
 

A generic implementation of stream storage in the file system. Stores files in a directory. The files it recognizes and accepts for creation can be all files in the directory or only files with a specific extension.

Namespace:   Microsoft.VisualStudio.Utilities
Assembly:  Microsoft.VisualStudio.Utilities (in Microsoft.VisualStudio.Utilities.dll)

System.Object
  Microsoft.VisualStudio.PlatformUI.DisposableObject
    Microsoft.VisualStudio.Utilities.FileStreamStorage<TKey>

public class FileStreamStorage<TKey> : DisposableObject, IStreamStorage<TKey>, 
	IEnumerable<TKey>, IEnumerable, IStreamStorageEvents<TKey>

Type Parameters

TKey

The type of the stream key.

NameDescription
System_CAPS_pubmethodFileStreamStorage<TKey>(IStreamStorageKeyFactory<TKey>, String, String)

Initializes a new instance of FileStreamStorage.

NameDescription
System_CAPS_pubpropertyEnableRaisingEvents

System_CAPS_pubpropertyIsDisposed

This API supports the product infrastructure and is not intended to be used directly from your code. Returns whether the object has been disposed once, which protects against double disposal.(Inherited from DisposableObject.)

System_CAPS_pubpropertyItem[TKey]

Open an existing stream in storage for reading.

System_CAPS_pubpropertyStorageFileExtension

Gets or sets the extension for contained files. If set to AllExtensions, the storage will recognize all files in the storage directory.

System_CAPS_pubpropertyStoragePath

Gets or sets the directory that will contain the stored files.

NameDescription
System_CAPS_pubmethodContains(TKey)

Determines whether the storage contains a stream with the given key.

System_CAPS_pubmethodCreate(TKey)

Opens a new stream for writing, adding it to storage.

System_CAPS_pubmethodDelete(TKey)

Deletes from storage the Stream identified by the given key.

System_CAPS_pubmethodDispose()

This API supports the product infrastructure and is not intended to be used directly from your code. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from DisposableObject.)

System_CAPS_protmethodDispose(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Standard virtual overload for IDisposable pattern.(Inherited from DisposableObject.)

System_CAPS_protmethodDisposeManagedResources()
System_CAPS_protmethodDisposeNativeResources()

This API supports the product infrastructure and is not intended to be used directly from your code. Allows derived classes to provide custom dispose handling for native resources.(Inherited from DisposableObject.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

This API supports the product infrastructure and is not intended to be used directly from your code. Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from DisposableObject.)

System_CAPS_pubmethodGetEnumerator()

Gets an enumerator for keys in storage.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetStreamSize(TKey, Int64, Int64)

Gets the number of bytes actually used by an existing Stream in the storage.

System_CAPS_pubmethodGetTimestamp(TKey, TimestampKind)

Gets the timestamp for an existing Stream in the storage.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOpen(TKey, StreamAccess)

Open an existing stream in storage.

System_CAPS_pubmethodSetTimestamp(TKey, TimestampKind, DateTime)

Sets the timestamp for an existing stream in the storage.

System_CAPS_protmethodThrowIfDisposed()

This API supports the product infrastructure and is not intended to be used directly from your code. Throws an ObjectDisposedException if this object has been disposed.(Inherited from DisposableObject.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticAllExtensions

Represents all file extensions.

NameDescription
System_CAPS_pubeventDisposing

This API supports the product infrastructure and is not intended to be used directly from your code. Raised when the event is being disposed, that is, while it is still accessible.(Inherited from DisposableObject.)

System_CAPS_pubeventStreamChanged

Raised when a stream is changed.

System_CAPS_pubeventStreamCreated

aised when a stream is created.

System_CAPS_pubeventStreamDeleted

Raised when a stream is deleted.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Gets an enumerator for keys in storage.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: