abort method

Article
05/02/2017

The abort method terminates a pending send.

Syntax

HRESULT retVal = object.abort();

Parameters

This method has no parameters.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Standards information

There are no standards that apply here.

Remarks

The abort method may be called in the time after the send method has been called, and before the onload event is raised. An error is returned if it is called outside of this interval.

Examples

A simple abort example.

  
// 1. Create XDR object 
xdr = new XDomainRequest(); 
// 2. Open connection with server using POST method
xdr.open("POST", "https://www.contoso.com/xdr.txt");
// 3. Send string data to server
xdr.send("data to be processed");   
// 4. abort
xdr.abort();