IStorage::CreateStorage

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method creates and opens a new storage object nested within this storage object.

Syntax

HRESULT CreateStorage( 
  const WCHAR* pwcsName, 
  DWORD grfMode, 
  DWORD reserved1, 
  DWORD reserved2, 
  IStorage** ppstg 
);

Parameters

  • pwcsName
    [in] Pointer to a wide character string that contains the name of the newly created storage object. This name can be used later to reopen the storage object.

  • grfMode
    [in] Access mode to use when opening the newly created storage object.

    See the STGM enumeration values for descriptions of the possible values.

  • reserved1
    [in] Reserved for future use. Set to zero.
  • reserved2
    [in] Reserved for future use. Set to zero.

  • ppstg
    [out] When successful, pointer to the location of the IStorage interface pointer to the newly-created storage object.

    This parameter is set to NULL if an error occurs.

Return Value

The following table shows the return values for this method.

Value Description

S_OK

The storage object was created successfully.

E_PENDING

Asynchronous Storage only: Part or all of the necessary data is currently unavailable.

For more information see the IFillLockBytes interface and Asynchronous Storage.

STG_E_ACCESSDENIED

Insufficient permissions to create storage object.

STG_E_FILEALREADYEXISTS

The name specified for the storage object already exists in the storage object and the grfmode flag includes the flag STGM_FAILIFTHERE.

STG_E_INSUFFICIENTMEMORY

The storage object was not created due to a lack of memory.

STG_E_INVALIDFLAG

The value specified for the grfMode flag is not a valid STGM enumeration value.

STG_E_INVALIDFUNCTION

The specified combination of grfMode flags is not supported.

STG_E_INVALIDNAME

Invalid value for pwcsName.

STG_E_INVALIDPOINTER

The pointer specified for the storage object was invalid.

STG_E_INVALIDPARAMETER

One of the parameters was invalid.

STG_E_REVERTED

The storage object has been invalidated by a revert operation above it in the transaction tree.

STG_E_TOOMANYOPENFILES

The storage object was not created because there are too many open files.

STG_S_CONVERTED

The existing stream with the specified name was replaced with a new storage object that contains a single stream called CONTENTS.

The new storage object will be added.

Remarks

If a storage with the name specified in the pwcsName parameter exists within the parent storage object, and the grfMode parameter includes the STGM_CREATE flag, the existing storage is replaced by the new one.

If the grfMode parameter includes the STGM_CONVERT flag, the existing element is converted to a stream object named CONTENTS and the new storage object is created that contains the CONTENTS stream object.

The destruction of the old element and the creation of the new storage object are subject to the transaction mode on the parent storage object.

If a storage object with the same name exists and grfMode is set to STGM_FAILIFTHERE, this method fails with the return value STG_E_FILEALREADYEXISTS.

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

Requirements

Header objidl.h, objidl.idl
Library ole32.lib, uuid.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

IFillLockBytes
IStorage
STGM