IPersistFileFormat::InitNew Method (UInt32)

 

Instructs the object to initialize itself in the untitled state.

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

int InitNew(
	unsigned int nFormatIndex
)

Parameters

nFormatIndex
Type: System::UInt32

[in] Index value that indicates the current format of the file. The nFormatIndex parameter controls the beginning format of the file. The caller should pass DEF_FORMAT_INDEX if the object is to choose its default format. If this parameter is non-zero, then it is interpreted as the index into the list of formats, as returned by a call to GetFormatList. An index value of 0 indicates the first format, 1 the second format, and so on.

Return Value

Type: System::Int32

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

From fpstfmt.idl:

HRESULT IPersistFileFormat::InitNew(
   [in] DWORD nFormatIndex
);

 

Return to top
Show: