IStorage::OpenStream

Opens an existing stream object within this storage object using the specified access permissions in grfMode.

HRESULT OpenStream(

const wchar_t * pwcsName,
//Points to name of stream to open
void * reserved1,
//Reserved; must be NULL
DWORD grfMode,
//Access mode for the new stream
DWORD reserved2,
//Reserved; must be zero
IStream ** ppstm
//Points to opened stream object
);

Parameters

pwcsName

[in]Points to the name of the stream to open.

reserved1

[in]Reserved for future use; must be NULL.

grfMode

[in]Specifies the access mode to use when opening the stream. See the STGM enumeration values for descriptions of the possible values.

reserved2

[in]Reserved for future use; must be zero.

ppstm

[out]Points to the location where the opened IStream interface pointer is returned; only valid if the operation is successful. This parameter is set to NULL if an error occurs.

Return Values

S_OK

The stream was successfully opened.

STG_E_ACCESSDENIED

Insufficient permissions to open stream.

STG_E_FILENOTFOUND

The stream with specified name does not exist.

STG_E_INSUFFICIENTMEMORY

The stream 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. For example, if this method is called without the STGM_SHARE_EXCLUSIVE flag.

STG_E_INVALIDNAME

Invalid value for pwcsName.

STG_E_INVALIDPOINTER

The pointer specified for the stream object was invalid.

STG_E_INVALIDPARAMETER

One of the parameters was invalid.

STG_E_REVERTED

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

STG_E_TOOMANYOPENFILES

The stream was not opened because there are too many open files.

Comments

There are restrictions on the permissions that can be given in grfMode. For example, the permissions on this storage object restrict the permissions on its streams.

Note to Callers

The OLE-provided compound file implementation of the IStorage::OpenStream method does not support the following behaviors:

  • The STGM_DELETEONRELEASE flag is not supported.

  • Transacted mode is not supported for stream objects.

  • Opening the same stream more than once from the same storage is not supported. The STGM_SHARE_EXCLUSIVE flag must be specified.

Other implementations of IStorage might support these features.

See Also

IStorage::CreateStream, IStream

Software for developers
Delphi Components
.Net Components
Software for Android Developers
More information resources
MegaDetailed.Net
Unix Manual Pages
Delphi Examples
Databases for Amazon shops developers
Amazon Categories Database
Browse Nodes Database