ondataavailable Event
Fires when new data is available.
| Inline HTML | <ELEMENT ondataavailable = "handler" ... > |
All platforms |
| Event property | object.ondataavailable = handler |
Microsoft® JScript® (compatible with ECMA 262 language specification) only |
| Named script | <SCRIPT FOR = object EVENT = ondataavailable> |
Microsoft Internet Explorer only |
JScript Syntax
oXMLDOMDocument.ondataavailable;
Visual Basic Syntax
oXMLDOMDocument.ondataavailable
C/C++ Syntax
HRESULT ondataavailable(void);
Return Values
S_OK
The value returned if successful.
Example
// Assumptions:
// The sink (an object of the class defined below) has been connected
// to the connection point (DIID_XMLDOMDocumentEvents).
// To see an example of how to connect the connection point,
// see the example for the IXMLDOMDocument::onreadystatechange Event.
BEGIN_DISPATCH_MAP(CXMLDOMSamples, CCmdTarget)
DISP_FUNCTION_ID(CXMLDOMSamples, "Data Available Event Handler",
DISPID_XMLDOMEVENT_ONDATAAVAILABLE, DOMDocOnDataAvailable, VT_EMPTY, 0)
END_DISPATCH_MAP()
class CXMLDOMSamples : public CCmdTarget
{
public:
void DOMDocOnDataAvailable();
};
void CXMLDOMSamples::DOMDocOnDataAvailable()
{
// Called whenever any data is available.
try
{
::MessageBox(NULL, _T("in ondataavailable()"), _T("Error"), MB_OK);
}
catch(...)
{
DisplayErrorToUser();
}
}
Remarks
When handling asynchronous data, it is useful to be able to start processing in parallel with the download as soon as data becomes available. The readyState property defines several states that specify the current status of the asynchronous download.
The event handler for this event can be explicitly set using the ondataavailable property.
This member is an extension of the Worldwide Web Consortium (W3C) Document Object Model (DOM).
Versioning
Implemented in: MSXML 3.0 and MSXML 6.0