Documentation
(C) IBM Corp. 1996, 1999

Text Extender: Administration and Programming

DesCloseDocument

Purpose

Closes a text document opened by DesOpenDocument, and releases the storage allocated during the return of document text and highlighting information.

Syntax

DESRETURN
  DesCloseDocument
     (DESBROWSESESSION     BrowseSession,
      DESHANDLE            DocumentHandle);

Function arguments

Table 7. DesCloseDocument arguments
Data Type Argument Use Description
DESBROWSESESSION BrowseSession input Browse session handle.
DESHANDLE DocumentHandle input Handle returned by DesOpenDocument identifying an opened text document.

Return codes

RC_SUCCESS
 
RC_INVALID_PARAMETER
RC_INVALID_SESSION
RC_SE_INCORRECT_HANDLE
RC_SE_IO_PROBLEM
RC_SE_LS_FUNCTION_FAILED
RC_SE_NOT_ENOUGH_MEMORY
RC_SE_REQUEST_IN_PROGRESS
RC_SE_WRITE_TO_DISK_ERROR

Restrictions

This function can be called only after you have opened a text document by calling DesOpenDocument.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]