IVsStructuredFileIO.CreateNew Method (String, UInt32, UInt32, UInt32, UInt32, IVsStructuredFileIOHelper, String, String, IVsPropertyFileOut)

 

Creates a new multi-format file with format index.

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

int CreateNew(
	string szFileName,
	uint nFormatIndex,
	uint dwShareMode,
	uint dwCreationDisposition,
	uint dwFlagsAndAttributes,
	IVsStructuredFileIOHelper pIVsStructuredFileIOHelper,
	string szFormatVersion,
	string szDescription,
	out IVsPropertyFileOut ppIVsPropertyFileOut
)

Parameters

szFileName
Type: System.String

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

nFormatIndex
Type: System.UInt32

[in] Integer containing the format index.

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.

szFormatVersion
Type: System.String

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

szDescription
Type: System.String

[in] Null-terminated string containing the description.

ppIVsPropertyFileOut
Type: Microsoft.VisualStudio.Shell.Interop.IVsPropertyFileOut

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

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::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
);
Return to top
Show: