KeyView 24.4
KeyView Viewing SDK Programming Guide

# Open

Opens a document.

The properties that begin with "`OPEN`" (for example, the `OPENMode` property and `OPENWaitOnOpen` property) apply to the `Open` method. However, they do not apply to the initial call to the `Open` method; that is, they do not affect the currently opened document and apply only to documents opened with subsequent calls to the `Open` method. See Control Properties.

## Syntax

    nRet = KeyView.Open(FileName)

## Parameters

Parameter | Type | Description
--- | --- | ---
`Filename` | String | A string containing the file name of the document to open.

## Returns

Type | Description
--- | ---
Short | `0` – if an error occurs during open. `1` – if the document opened successfully. `2` – if the document is of an unknown format. `3` – if no viewer is available for the document format. `4` – if the document is password-protected. `5` – if the drawing routines have not been initialized. `6` – if the requested page does not exist, or is being displayed before all previous pages have been displayed. `7` – if the document does not support this feature (for example, ZIP files, video, or audio). `8` – if the KeyView license is invalid. `9` – if the KeyView license is expired. `10` – if the input file or stream is invalid or corrupt.

Copyright 2016-2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.4

Topic Title: Open