IStorage::OpenStorage
This method opens an existing storage object with the specified name according to the specified access mode.
HRESULT OpenStorage(
const WCHAR *pwcsName,
IStorage *pstgPriority,
DWORD grfMode,
SNB snbExclude,
DWORD reserved,
IStorage **ppstg
);
Parameters
- pwcsName
[in] Pointer to a wide character string that contains the name of the storage object to open. It is ignored if pstgPriority is non-NULL. - pstgPriority
[in] If the pstgPriority parameter is not NULL, it is an IStorage pointer to a previous opening of an element of the storage object, usually one that was opened in priority mode. The storage object should be closed and re-opened according to grfMode. When the IStorage::OpenStorage method returns, pstgPriority is no longer valid. Use the value supplied in the ppstg parameter. If the pstgPriority parameter is NULL, it is ignored. - grfMode
[in] Specifies the access mode to use when opening the storage object. See the STGM enumeration values for descriptions of the possible values. Whatever other modes you may choose, you must at least specify STGM_SHARE_EXCLUSIVE when calling this method. - snbExclude
[in] Set to NULL. A non-NULL value will return STG_E_INVALIDPARAMETER. - reserved
[in] Reserved for future use; set to zero. - ppstg
[out] When the operation is successful, pointer to the location of an IStorage pointer to the opened 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 opened successfully. |
| E_PENDING | Asynchronous Storage only: Part or all of the storages data is currently unavailable. For more information see IFillLockBytes and Asynchronous Storage. |
| STG_E_ACCESSDENIED | Insufficient permissions to open storage object. |
| STG_E_FILENOTFOUND | The storage object with the specified name does not exist. |
| STG_E_INSUFFICIENTMEMORY | The storage object was not opened 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. In direct mode, the new storage is immediately written to disk. In transacted mode, the new storage is written to a temporary storage in memory and later written to disk when it is committed. |
Remarks
Storage objects can be opened with STGM_DELETEONRELEASE, in which case the object is destroyed when it receives its final release. This is useful for creating temporary storage objects.
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.
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.