 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This method retrieves a STATSTGstructure for this byte array object.
Syntax
HRESULT Stat( STATSTG* pstatstg, DWORD grfStatFlag ); |
Parameters
- pstatstg
-
[out] Pointer to a STATSTGstructure 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 pwcsNamemember of the STATSTGstructure through values taken from the STATFLAGenumeration.
If the STATFLAG_NONAME is specified, the pwcsNamemember of STATSTGis 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 STATSTGstructure was successfully returned at the specified location. |
|
E_OUTOFMEMORY |
The STATSTGstructure was not returned due to a lack of memory for the name member in the structure. |
|
STG_E_ACCESSDENIED |
The STATSTGstructure was not returned because the caller did not have access to the byte array. |
|
STG_E_INSUFFICIENTMEMORY |
The STATSTGstructure was not returned, due to a lack of memory. |
|
STG_E_INVALIDFLAG |
The value for the grfStateFlagparameter is not valid. |
|
STG_E_INVALIDPOINTER |
The value for the pStatStgparameter is not valid. |
Remarks
ILockBytes::Statshould supply information about the byte array object in a STATSTGstructure.
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 |