IVsStructuredFileIO.CreateNew Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Creates a new multi-format file with format index.

public:
 int CreateNew(System::String ^ szFileName, System::UInt32 nFormatIndex, System::UInt32 dwShareMode, System::UInt32 dwCreationDisposition, System::UInt32 dwFlagsAndAttributes, Microsoft::VisualStudio::Shell::Interop::IVsStructuredFileIOHelper ^ pIVsStructuredFileIOHelper, System::String ^ szFormatVersion, System::String ^ szDescription, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsPropertyFileOut ^ % ppIVsPropertyFileOut);

public:
 int CreateNew(Platform::String ^ szFileName, unsigned int nFormatIndex, unsigned int dwShareMode, unsigned int dwCreationDisposition, unsigned int dwFlagsAndAttributes, Microsoft::VisualStudio::Shell::Interop::IVsStructuredFileIOHelper ^ pIVsStructuredFileIOHelper, Platform::String ^ szFormatVersion, Platform::String ^ szDescription, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsPropertyFileOut ^ &  ppIVsPropertyFileOut);

int CreateNew(std::wstring const & szFileName, unsigned int nFormatIndex, unsigned int dwShareMode, unsigned int dwCreationDisposition, unsigned int dwFlagsAndAttributes, Microsoft::VisualStudio::Shell::Interop::IVsStructuredFileIOHelper const & pIVsStructuredFileIOHelper, std::wstring const & szFormatVersion, std::wstring const & szDescription, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsPropertyFileOut const & & ppIVsPropertyFileOut);

public int CreateNew (string szFileName, uint nFormatIndex, uint dwShareMode, uint dwCreationDisposition, uint dwFlagsAndAttributes, Microsoft.VisualStudio.Shell.Interop.IVsStructuredFileIOHelper pIVsStructuredFileIOHelper, string szFormatVersion, string szDescription, out Microsoft.VisualStudio.Shell.Interop.IVsPropertyFileOut ppIVsPropertyFileOut);

abstract member CreateNew : string * uint32 * uint32 * uint32 * uint32 * Microsoft.VisualStudio.Shell.Interop.IVsStructuredFileIOHelper * string * string * IVsPropertyFileOut -> int

Public Function CreateNew (szFileName As String, nFormatIndex As UInteger, dwShareMode As UInteger, dwCreationDisposition As UInteger, dwFlagsAndAttributes As UInteger, pIVsStructuredFileIOHelper As IVsStructuredFileIOHelper, szFormatVersion As String, szDescription As String, ByRef ppIVsPropertyFileOut As IVsPropertyFileOut) As Integer

Parameters

szFileName

String

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

nFormatIndex

UInt32

[in] Integer containing the format index.

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.

szFormatVersion

String

[in] Null-terminated string containing the format version.

szDescription

String

[in] Null-terminated string containing the description.

ppIVsPropertyFileOut

IVsPropertyFileOut

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

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::CreateNew(  
   [in] LPCOLESTR szFileName,  
   [in] ULONG nFormatIndex,  
   [in] DWORD dwShareMode,  
   [in] DWORD dwCreationDisposition,  
   [in] DWORD dwFlagsAndAttributes,  
   [in] IVsStructuredFileIOHelper *pIVsStructuredFileIOHelper,  
   [in] LPCOLESTR szFormatVersion,  
   [in] LPCOLESTR szDescription,  
   [out] IVsPropertyFileOut **ppIVsPropertyFileOut  
);