IStorage::Stat
This method retrieves the STATSTG structure for this open storage object.
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] Specifies that some of the members in the STATSTG structure are not returned, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration.
Return Values
One of the values described in the following table is returned.
| Value | Description |
|---|---|
| S_OK | The STATSTG structure was successfully returned at the specified location. |
| 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 | 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. IStorage::EnumElements 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.
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.