IBindStatusCallback::OnDataAvailable
A version of this page is also available for
4/8/2010
This method provides data to the client as it becomes available during asynchronous bind operations.
Syntax
HRESULT OnDataAvailable(
DWORD grfBSCF,
DWORD dwSize,
FORMATETC* pformatetc,
STGMEDIUM* pstgmed
);
Parameters
- grfBSCF
[in] Unsigned long integer value taken from the BSCF enumeration that indicates the kind of data available.
- dwSize
[in] Unsigned long integer value that contains the size, in bytes, of the total data available from the current bind operation.
- pformatetc
[in] Address of the FORMATETC structure that indicates the format of the available data. This parameter is used when the bind operation is caused by the IMoniker::BindToStorage method. If there is no format associated with the available data, pformatetc might contain CF_NULL. Each different call to IBindStatusCallback::OnDataAvailable can pass in a new value for this parameter, although they all should always point to the same data.
- pstgmed
[in] Address of the STGMEDIUM structure that contains the pointers to the interfaces, such as IStream and IStorage, that can be used to access the data. In the asynchronous case, client applications might have received a second pointer to the IStream or IStorage interface from the IMoniker::BindToStorage method, on which the client application must call Release to avoid memory leaks.
Return Value
Returns S_OK if this is successful or E_INVALIDARG if one or more parameters are invalid.
Remarks
During asynchronous IMoniker::BindToStorage bind operations, an asynchronous moniker calls this method to provide data to the client as it becomes available.
Be aware that the behavior of the storage returned in pstgmed depends on the BINDF flags returned in the IBindStatusCallback::GetBindInfo method. This storage can be asynchronous or blocking, and the bind operation can follow a data pull model or a data push model. Moreover, realize that for BINDF bind operations, you cannot seek backward into data streams provided in IBindStatusCallback::OnDataAvailable. On the other hand, for data push model bind operations, it is usually possible to seek back into a data stream and read any data that was downloaded for an ongoing IMoniker::BindToStorage operation.
Requirements
| Header | urlmon.h, urlmon.idl |
| Library | urlmon.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |