This topic has not yet been rated - Rate this topic

IStream::Stat method

Applies to: desktop apps | Metro style apps

The Stat method retrieves the STATSTG structure for this stream.

Syntax

Copy

HRESULT Stat(
  [out]  STATSTG *pstatstg,
  [in]   DWORD grfStatFlag
);

Parameters

pstatstg [out]: Pointer to a STATSTG structure where this method places information about this stream object.
grfStatFlag [in]: Specifies that this method does not return some of the members in the STATSTG structure, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration.

Return value

This method can return one of these values.

S_OK: The STATSTG structure was successfully returned at the specified location.
E_PENDING: Asynchronous Storage only: Part or all of the stream's data is currently unavailable. For more information see IFillLockBytes and Asynchronous Storage.
STG_E_ACCESSDENIED: The caller does not have enough permissions for accessing statistics for this storage object.
STG_E_INSUFFICIENTMEMORY: The STATSTG structure was not returned due to a lack of memory.
STG_E_INVALIDFLAG: The value for the grfStateFlag parameter is not valid.
STG_E_INVALIDPOINTER: The pStatStg pointer is not valid.
STG_E_REVERTED: The object has been invalidated by a revert operation above it in the transaction tree.

Remarks

IStream::Stat retrieves a pointer to the STATSTG structure that contains information about this open stream. When this stream is within a structured storage and IStorage::EnumElements is called, it creates an enumerator object with the IEnumSTATSTG interface on it, which can be called to enumerate the storages and streams through the STATSTG structures associated with each of them.

Requirements