IStorage::CreateStorage

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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

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] Specifies the 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 pointer to the newly-created storage object. This parameter is set to NULL if an error occurs.

Return Values

One of the values described in the following table is returned.

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 IFillLockBytes 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 grfmodeflag 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 grfModeflag is not a valid STGMenumeration value.
STG_E_INVALIDFUNCTION	The specified combination of grfModeflags 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 pwcsNameparameter already exists within the parent storage object, and the grfModeparameter includes the STGM_CREATE flag, the existing storage is replaced by the new one. If the grfModeparameter 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 both subject to the transaction mode on the parent storage object.

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

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	2.0 and later	Objidl.h

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.