IStorage::Stat
A version of this page is also available for
4/8/2010
This method retrieves the STATSTG structure for this open storage object.
Syntax
HRESULT Stat(
STATSTG* pstatstg,
DWORD grfStatFlag
);
Parameters
pstatstg
[out] On return, pointer to a STATSTG structure where this method places information about the open storage object.This parameter is NULL if an error occurs.
grfStatFlag
[in] Value that specifies that some of the members in the STATSTG structure are not returned. This saves a memory allocation operation.Values are taken from the STATFLAG enumeration.
Return Value
The following table shows the return values for this method.
| Value | Description |
|---|---|
S_OK |
The STATSTG structure was successfully returned at the specified location. |
E_PENDING |
Asynchronous Storage only: Part or all of the storage's data is currently unavailable. For more information see the IFillLockBytes interface and Asynchronous Storage. |
STG_E_ACCESSDENIED |
The caller does not have sufficient 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_INVALIDPARAMETER |
One of the parameters was invalid. |
Remarks
IStorage::Stat retrieves the STATSTG structure for the current storage. This structure contains statistical information about the storage.
The IStorage::EnumElements method creates an enumerator object with the IEnumSTATSTG interface, though which you can enumerate the substorages and streams of a storage through the STATSTG structure of each.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Requirements
| Header | objidl.h, objidl.idl |
| Library | ole32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |