IXMLDOMDocument::put_ondataavailable Method

Specifies the event handler for the ondataavailable event.

Syntax

HRESULT put_ondataavailable(
    VARIANT ondataavailableSink);

Parameters

ondataavailableSink

[in] Name of the function that should be called when the readyState property value changes to the value INTERACTIVE, indicating that data is available.

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.

You can call the IXMLDOMDocument object's QueryInterface method to obtain the IConnectionPointContainer interface, which is used in event management. The DISPID for this event is DISPID_XMLDOMEVENT_ONDATAAVAILABLE.