async Property (Compact 2013)

  • Article

3/26/2014

Specifies if asynchronous download is permitted.

Note

This property is only supported on operating systems (OSs) that have Windows Internet API (WinInet) and URL Moniker Services (URLMON) included.

Syntax

boolValue = oXMLDOMDocument.async;
objXMLDOMDocument.async = boolValue;

HRESULT get_async(  VARIANT_BOOL* isAsync);
HRESULT put_async(  VARIANT_BOOL isAsync);

Parameters

Script

None.

C/C++

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

Return Value

Script

Boolean. Returns True if asynchronous download is permitted; False if not. Default is True.

C/C++

  • S_OK
    Value returned if successful.
  • E_INVALIDARG (for get_async only)
    Value returned if isAsync is Null.

Remarks

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

This member is an extension of the World Wide Web Consortium (W3C) Document Object Model (DOM).

This property is read/write, and applies to the following interface:

DOMDocument

Requirements

Header

msxml2.h,
msxml2.idl

See Also

Reference

XML DOM Properties
onreadystatechange Property (DOMDocument)
readyState Property (DOMDocument)