StgOpenAsyncDocfileOnIFillLockBytes

Opens an existing root asynchronous storage object on a byte array wrapper object provided by the caller.

WINOLEAPI StgOpenAsyncDocFileOnIFillLockBytes(
  IFillLockBytes *pflb, //Pointer to byte array wrapper object
  DWORD grfmode,        //Storage access mode
  DWORD asyncFlags,     //Asynchronous storage flags
  IStorage **ppstgOpen  //Address of output variable that receives 
                        // the IStorage interface pointer
);
 

Parameters

pflb

[in] IFillLockBytes pointer to the byte array wrapper object that contains the storage object to be opened.

grfmode

[in] Specifies the access mode to use to open the storage object. The most common access mode, taken from the STGM enumeration, is STGM_READ.

asyncFlags

[in] Indicates whether a connection point on a storage is inherited by its substorages and streams. ASYNC_MODE_COMPATIBILITY indicates that the connection point is inherited; ASYNC_MODE_DEFAULT indicates that the connection point is not inherited.

ppstgOpen

[out] Address of IStorage* pointer variable that receives the interface pointer to the root asynchronous storage object.

Return Values

This function supports the standard return values E_OUTOFMEMORY, E_UNEXPECTED, E_INVALIDARG, and E_FAIL, as well as the following:

E_PENDING

Data is currently unavailable.

E_NOINTERFACE

A pointers was not returned to the requested interface.

STG_E_INSUFFICIENTMEMORY

There is insufficient memory to complete this operation.

Remarks

The root storage of the asynchronous storage object is opened according to the access mode in the grfMode parameter. A pointer to the IStorage interface on the opened storage object is supplied through the ppstgOpen parameter.

The byte array wrapper object must have been previously instantiated through a call to the StgGetIFillLockBytesOnFile function.

StgOpenAsyncDocFileOnIFillLockBytes does not support priority access mode or exclusions. Otherwise, it works in much the same way as the StgOpenStorageOnILockBytes function.

The returned storage object has a connection point for IProgressNotify.

QuickInfo

  Windows NT: Use version 4.0 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in objbase.h.
  Import Library: Included as a resource in ole32.dll.

See Also

IFillLockBytes, ILockBytes, StgGetIFillLockBytesOnFile, StgOpenStorageOnILockBytes.