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 in which this method
places information about this byte array object. The pointer is NULL if an
error occurs.
-
grfStatFlag
-
[in]Specifies whether this method should supply the pwcsName member of
the STATSTG structure through values taken from the
STATFLAG enumeration. If the STATFLAG_NONAME is
specified, the pwcsName member of STATSTG is not supplied, thus
saving a memory allocation operation. The other possible value,
STATFLAG_DEFAULT, indicates that all STATSTG members be supplied.
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.
Remarks
ILockBytes::Stat should supply information about the byte array object
in a STATSTG structure.
See Also
STATFLAG, STATSTG,
ILockBytes&emdash;File-Based
Implementation,
ILockBytes&emdash;Global
Memory Implementation