Export (0) Print
Expand All

IStorage::Stat method

The Stat method retrieves the STATSTG structure for this open storage object.

Syntax


HRESULT Stat(
  [out]  STATSTG *pstatstg,
  [in]   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 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 storage'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_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

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Header

Objidl.h

IDL

Objidl.idl

Library

Uuid.lib

DLL

Ole32.dll

IID

IID_IStorage is defined as 0000000B-0000-0000-C000-000000000046

See also

IStorage - Compound File Implementation
STATFLAG
STATSTG
IEnumSTATSTG
IStorage::SetClass
IStorage::SetElementTimes
IStorage::SetStateBits

 

 

Community Additions

ADD
Show:
© 2014 Microsoft