IPersistFileFormat.InitNew(UInt32) Method

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Instructs the object to initialize itself in the untitled state.

public:
 int InitNew(System::UInt32 nFormatIndex);

public:
 int InitNew(unsigned int nFormatIndex);

int InitNew(unsigned int nFormatIndex);

public int InitNew (uint nFormatIndex);

abstract member InitNew : uint32 -> int

Public Function InitNew (nFormatIndex As UInteger) As Integer

Parameters

nFormatIndex: 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(String). An index value of 0 indicates the first format, 1 the second format, and so on.

Returns

Int32

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

Remarks

COM Signature

From fpstfmt.idl:

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

Applies to