IVsStructuredFileIO.OpenExisting Method (String, UInt32, UInt32, UInt32, IVsStructuredFileIOHelper, UInt32, IVsPropertyFileIn, String[])

 

Open 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.

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

int OpenExisting(
	string szFileName,
	uint dwShareMode,
	uint dwCreationDisposition,
	uint dwFlagsAndAttributes,
	IVsStructuredFileIOHelper pIVsStructuredFileIOHelper,
	out uint pnFormatIndex,
	out IVsPropertyFileIn ppIVsPropertyFileIn,
	string[] pbstrFormatVersion
)

Parameters

szFileName
Type: System.String

[in] Null-terminated string containing the file name.

dwShareMode
Type: System.UInt32

[in] Double word containing the share mode.

dwCreationDisposition
Type: System.UInt32

[in] Double word containing the creation disposition.

dwFlagsAndAttributes
Type: System.UInt32

[in] Double word containing the flags and attributes.

pIVsStructuredFileIOHelper
Type: Microsoft.VisualStudio.Shell.Interop.IVsStructuredFileIOHelper

[in] Pointer to an IVsStructuredFileIOHelper object.

pnFormatIndex
Type: System.UInt32

[out] Pointer to an integer containing the format index.

ppIVsPropertyFileIn
Type: Microsoft.VisualStudio.Shell.Interop.IVsPropertyFileIn

[out] Pointer to a pointer to an IVsPropertyFileIn object.

pbstrFormatVersion
Type: System.String[]

[out, optional] Pointer to a string containing the format version.

Return Value

Type: System.Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

From vsshell.idl:

HRESULT IVsStructuredFileIO::OpenExisting(
   [in] LPCOLESTR szFileName,
   [in] DWORD dwShareMode,
   [in] DWORD dwCreationDisposition,
   [in] DWORD dwFlagsAndAttributes,
   [in] IVsStructuredFileIOHelper *pIVsStructuredFileIOHelper,
   [out] ULONG *pnFormatIndex,
   [out] IVsPropertyFileIn **ppIVsPropertyFileIn,
   [out, optional] BSTR *pbstrFormatVersion
);
Return to top
Show: