Microsoft XML SDK 2.6 - XML Reference

IXMLDOMDocument::async Method

IXMLDOMDocument::get_async Method

Indicates whether synchronous or asynchronous download is set. When set to True (the default setting), the load method returns control to the caller before the download is finished. You can then use the readyState property to check the status of the download. You can also attach an onreadystatechange handler or connect to the onreadystatechange event to be notified when the ready state changes so that you know when the download is complete.

Visual Basic Syntax

boolValue = oXMLDOMDocument.async

C/C++ Syntax

HRESULT get_async(
    VARIANT_BOOL *isAsync);

Parameters

isAsync [out]
True if asynchronous download is permitted; False if not.

C/C++ Return Values

S_OK
Value returned if successful.
E_INVALIDARG
Value returned if isAsync is Null.

Remarks

This member is an extension of the W3C DOM.



IXMLDOMDocument::put_async Method

Use to select synchronous or asynchronous download. When set to True (the default setting), the load method returns control to the caller before the download is finished. You can then use the readyState property to check the status of the download. You can also attach an onreadystatechange handler or connect to the onreadystatechange event to be notified when the ready state changes so that you know when the download is complete.

Visual Basic Syntax

objXMLDOMDocument.async = boolValue

C/C++ Syntax

HRESULT put_async(
    VARIANT_BOOL isAsync);

Parameters

isAsync [in]
True if asynchronous download is permitted; False if not.

C/C++ Return Values

Returns S_OK if successful, or an error code otherwise.

Remarks

This member is an extension of the W3C DOM.

See Also

IXMLDOMDocument Interface