IVsStructuredFileIO Interface

Provides a common way to perform multi-format saves. You can get an instance of the interface from the SVsStructuredFileIO (SID_SVsStructuredFileIO) service.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

public interface IVsStructuredFileIO

The IVsStructuredFileIO type exposes the following members.

Public methodCreateNewCreates a new multi-format file with format index.
Public methodFindFormatIndexReturns the format index for the CodePage of the data object.
Public methodGetFormatInfoReturns the format information for the format index.
Public methodGetFormatListReturns the format list for the file types supported by your VSPackage.
Public methodOpenExistingOpen a previously created structured file data element and returns a pointer to the format index, data element, and pointer to a string containing the format version.

The IVsStructuredFileIO interface provides a common way to do multi-format saves. It includes rudimentary support for using IPersistFileFormat.

The IVsStructuredFileIOHelper interface works with IVsStructuredFileIO and enables loading tokens in persisted files that are to be loaded with localized strings. For example, the IVsStructuredFileIO implementation looks for property values of the form "nnnn", where "nnnn" is a series of decimal digits, and requests string ID nnnn to be loaded through your implementation of LoadLocalizedString.

Notes to Implementers

Implemented by VSPackages that need to take advantage of multi-format file saves for persisted files.

Notes to Callers

Called by the environment when persisted data is to be saved to a structured file.

Community Additions