IVsStructuredFileIO.OpenExisting Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

int OpenExisting(std::wstring const & szFileName, unsigned int dwShareMode, unsigned int dwCreationDisposition, unsigned int dwFlagsAndAttributes, Microsoft::VisualStudio::Shell::Interop::IVsStructuredFileIOHelper const & pIVsStructuredFileIOHelper, [Runtime::InteropServices::Out] unsigned int & pnFormatIndex, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsPropertyFileIn const & & ppIVsPropertyFileIn, std::Array <std::wstring const &> const & pbstrFormatVersion);

public int OpenExisting (string szFileName, uint dwShareMode, uint dwCreationDisposition, uint dwFlagsAndAttributes, Microsoft.VisualStudio.Shell.Interop.IVsStructuredFileIOHelper pIVsStructuredFileIOHelper, out uint pnFormatIndex, out Microsoft.VisualStudio.Shell.Interop.IVsPropertyFileIn ppIVsPropertyFileIn, string[] pbstrFormatVersion);

abstract member OpenExisting : string * uint32 * uint32 * uint32 * Microsoft.VisualStudio.Shell.Interop.IVsStructuredFileIOHelper * uint32 * IVsPropertyFileIn * string[] -> int

Public Function OpenExisting (szFileName As String, dwShareMode As UInteger, dwCreationDisposition As UInteger, dwFlagsAndAttributes As UInteger, pIVsStructuredFileIOHelper As IVsStructuredFileIOHelper, ByRef pnFormatIndex As UInteger, ByRef ppIVsPropertyFileIn As IVsPropertyFileIn, Optional pbstrFormatVersion As String()) As Integer

Parameters

szFileName: String

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

dwShareMode: UInt32

[in] Double word containing the share mode.

dwCreationDisposition: UInt32

[in] Double word containing the creation disposition.

dwFlagsAndAttributes: UInt32

[in] Double word containing the flags and attributes.

pIVsStructuredFileIOHelper: IVsStructuredFileIOHelper

[in] Pointer to an IVsStructuredFileIOHelper object.

pnFormatIndex: UInt32

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

ppIVsPropertyFileIn: IVsPropertyFileIn

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

pbstrFormatVersion: String[]

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

Returns

Int32

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

Remarks

COM Signature

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  
);

Applies to

Share via