Word Close (Session)

Word Close (Session)

Type: word-close  ·  Package: Word Activities v1.0.4

Closes a Word session and releases the document from memory. It is the counterpart of Word Open / Word Create when you work without body.

How it works

Releases the given session. After that, the session can no longer be used. Closing a session that was already closed raises no error. If you don’t set session, it closes the one of the enclosing body (not needed: the body closes it by itself).

Closing does not save

Word Close does not save changes. If you changed the document, call Word Save first.

Required parameters

None.

Optional parameters

Parameter	Type	Default	Description
session	ZoanWordSession	—	The session from Word Open or Word Create.

Output

This activity does not return a value.

Example

Word Open   path = asset("report.docx")   → output: doc
Word Read Tables   session = doc   → output: tables
Word Set Property  session = doc   property = Category   value = "Reviewed"
Word Save   session = doc
Word Close  session = doc

Do I need Word Close?

Only in the mode without body. With body, the session is closed (and, with Create, saved) automatically at the end. To guarantee the close even if something fails, use a Try / Catch with Word Close in the finally.

Common errors

Message	Cause and fix
'session' must be a valid Word session (use word-open or word-create).	No session was passed (or the variable holds no session) and the activity is not inside a Word Open/Create body.

Related activities

• Word Save — save before closing.
• Word Open / Word Create — open the session.