ILockBytes::Stat

Retrieves a STATSTG structure containing information for this byte array object.

HRESULT Stat(

STATSTG *pstatstg,	//Location for STATSTG structure
DWORD grfStatFlag	//Values taken from the STATFLAG enumeration
);

Parameters
pstatstg

[out]Points to a STATSTG structure where this method places information about this byte array object. The pointer is NULL if an error occurs.

grfStatFlag

[in]Specifies that this method not return some of the fields in the STATSTG structure, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration.

Return Values
S_OK

The STATSTG structure was successfully returned at the specified location.

E_OUTOFMEMORY

The STATSTG structure was not returned due to a lack of memory for the name field in the structure.

STG_E_ACCESSDENIED

The STATSTG structure was not returned because the caller did not have access to the byte array.

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 value for the pStatStg parameter is not valid.

Comments
The OLE-provided IStorage::Stat implementation calls the ILockBytes::Stat method to retrieve information about a root storage object. If there is no reasonable name for the byte array, then the OLE-provided ILockBytes::Stat method returns NULL in the pwcsName field of the STATSTG structure.