Office development

File.closeAsync method (JavaScript API for Office)

Office and SharePoint Add-ins

Closes the document file.

Hosts:

PowerPoint, Word

Available in Requirement set

File

Added in

1.1

See all support details


                      File.closeAsync(callback);

callback

Type: object

A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional.

When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter.

In the callback function passed to the closeAsync method, you can use the properties of the AsyncResult object to return the following information.

Property

Use to...

AsyncResult.value

Always returns undefined because there is no object or data to retrieve.

AsyncResult.status

Determine the success or failure of the operation.

AsyncResult.error

Access an Error object that provides error information if the operation failed.

AsyncResult.asyncContext

Access your user-defined object or value, if you passed one as the asyncContext parameter.

No more than two documents are allowed to be in memory; otherwise the Document.getFileAsync operation will fail. Use the File.closeAsync method to close the file when you are finished working with it.

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 Office Add-ins.

Office for Windows desktop

Office Online
(in browser)

Office for iPad

PowerPoint

Word

Available in requirement sets

File

Minimum permission level

Restricted

Add-in types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for PowerPoint and Word in Office for iPad.

1.0

Introduced

Show:
© 2016 Microsoft