IStorage::Stat method (objidl.h)
The Stat method retrieves the STATSTG structure for this open storage object.
Syntax
HRESULT Stat(
[out] STATSTG *pstatstg,
[in] DWORD grfStatFlag
);
Parameters
[out] pstatstg
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.
[in] grfStatFlag
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 value
This method can return one of these values.
| Return code | 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. |
| 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_INVALIDPARAMETER | One of the parameters was not valid. |
Remarks
IStorage::Stat retrieves the STATSTG structure for the current storage object. The STATSTG structure contains statistical information about the storage object. IStorage::EnumElements returns a pointer to an enumerator object. The enumerator object returned by this method implements the IEnumSTATSTG interface, through which the data stored in the array of the STATSTG structures is enumerated.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps | UWP apps] |
| Minimum supported server | Windows 2000 Server [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | objidl.h |
| Library | Uuid.lib |
| DLL | Ole32.dll |