Microsoft XML 2.5 SDK


 

IXMLDOMDocument::ondataavailable Event

[This is preliminary documentation and subject to change.]

Provides the event handler for the ondataavailable event.

Syntax

HRESULT ondataavailable(void);

C/C++ Return Value

Returns S_OK if successful, or an error code otherwise.

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 ondataavailable event fires as soon as data is available for such processing. The readystate property defines several states that more closely specify the current status of the asynchronous download.

This member is an extension of the W3C DOM.

C/C++ 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 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 avaiable 
   try
   {
       ::MessageBox(NULL, _T("in ondataavailable()"), _T("Error"), MB_OK);
   }
   catch(...)
   {
      DisplayErrorToUser();
   }
}