ILockBytes::Stat
A version of this page is also available for
4/8/2010
This method retrieves a STATSTGstructure for this byte array object.
Syntax
HRESULT Stat(
STATSTG* pstatstg,
DWORD grfStatFlag
);
Parameters
- pstatstg
[out] Pointer 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] Value that 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. This saves a memory allocation operation.
The other possible value, STATFLAG_DEFAULT, indicates that all STATSTG members be supplied.
Return Value
The following table shows the return values for this method.
| Value | Description |
|---|---|
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 member 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.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Requirements
| Header | objidl.h, objidl.idl |
| Library | ole32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |