The following table shows the return values for this method.

A container application can call this method when it needs to initialize a new object, for example, with an InsertObject command.

An object that supports the IPersistStorageinterface must have access to a valid storage object at all times while it is running. This includes the time just after the object has been created but before it has been made persistent.

The object's container must provide the object with a valid IStoragepointer to the storage during this time through the call to IPersistStorage::InitNew.

Depending on the container's state, a temporary file might have to be created for this purpose.

If the object wants to retain the IStorageinstance, it must call the IUnknown::AddRefmethod to increment its reference count.

After the call to IPersistStorage::InitNew, the object is in either the loaded or running state.

For example, if the object class has an in-process server, the object will be in the running state. However, if the object uses the default handler, the container's call to InitNewonly invokes the handler's implementation, which does not run the object.

Later, if the container runs the object, the handler calls the IPersistStorage::InitNewmethod for the object.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Notes to Callers

Rather than calling IPersistStorage::InitNewdirectly, you typically call the OleCreatehelper function that does the following:

1. Calls the CoCreateInstancefunction to create an instance of the object class
   
   
2. Queries the new instance for the IPersistStorageinterface
   
   
3. Calls the IPersistStorage::InitNewmethod to initialize the object
   
   

The container application should cache the IPersistStoragepointer to the object for use in later operations on the object.

Notes to Implementers

An implementation of IPersistStorage::InitNewshould initialize the object to its default state, taking the following steps:

1. Pre-open and cache the pointers to any streams or storages that the object will need to save itself to this storage.
   
   
2. Call IPersistStorage::AddRefand cache the storage pointer that is passed in.
   
   
3. Call the WriteFmtUserTypeStgfunction to write the native clipboard format and user type string for the object to the storage object.
   
   
4. Set the dirty flag for the object.
   
   

The first two steps are particularly important for ensuring that the object can save itself in low memory situations. Pre-opening and holding onto pointers to the stream and storage interfaces guarantee that a save operation to this storage will not fail due to insufficient memory.

Your implementation of this method should return the CO_E_ALREADYINITIALIZED error code if it receives a call to either the IPersistStorage::InitNewmethod or the IPersistStorage::Loadmethod after it is already initialized.