Error object (JavaScript API for Office)

apps for Office

Provides specific information about an error that occurred during an asynchronous data operation.

Last modified: March 02, 2015

Hosts:

Access, Excel, Outlook, PowerPoint, Project, Word

Last changed in

1.1

See all support details

asyncResult.error

Properties

Name

Description

code

Gets the numeric code of the error.

name

Gets the name of the error.

message

Gets a detailed description of the error.

The Error object is accessed from the AsyncResult object that is returned in the function passed as the callback argument of an asynchronous data operation, such as the setSelectedDataAsync method of the Document object.

The following example uses the setSelectedDataAsync method to set the selected text to "Hello World!", and if that fails, displays the values of the name and message properties of the Error object.

function setText() {

    Office.context.document.setSelectedDataAsync("Hello World!", {},
        function (asyncResult) {
            if (asyncResult.status === "failed")
            var err = asyncResult.error; 
                write(err.name + ": " + err.message);
        });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

A checkmark (√) in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running apps for Office.

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

OWA for Devices

Outlook for Mac

Access

Excel

Outlook

PowerPoint

Project

Word

Minimum permission level

Restricted

App types

Content, mail, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for content apps for Access.

1.0

Introduced

Show:
© 2015 Microsoft