IBM Lotus Domino Designer 8.5
Versions 8.5 and 8.5.1

Open method

Associates a file with a stream.

Defined in

NotesStream

Syntax

flag = notesStream.Open( pathname$ [ , charset$ ] )

Parameters

pathname$

String. The full path name of a file. Must be valid for the current platform.

charset$

String. Optional. The character set that describes the file content. Defaults to "System."

Return value

flag

Boolean.

True if the file opens successfully.
False if the open fails. See the usage notes below.

Usage

This method creates the file if it does not exist.

When a stream is opened, property values are:

Bytes is 0 for a new file and the number of bytes in the file for an existing file.
Charset is as specified for charset$.
Position is 0.
IsEOS is True if the stream is empty; otherwise, it is False.
IsReadOnly is True if the file is read-only, False if the file is read-write.

It is recommended that you call Close when you are finished processing the stream.

Valid character sets include: ASCII, Big5, Binary, EUC-JP, EUC-KR, EUC-TW, GB2312, ISO-2022-JP, ISO-2022-KR, ISO-8859-1 through ISO-8859-9, ISO-8859-15, KOI8-R, Latin4, Shift_JIS, System, TCVN3, Unicode, Unicode-1-1, US-ASCII, UTF-7, UTF-8, UTF-16, UTF-16BE, UTF-16LE, Windows-1250 through Windows-1258, and Windows-874. Binary implies byte operations only on the stream. Unicode is the same as UTF-16 and Unicode-1-1 is a compatible subset of UTF-16.

This method fails if:

The path name is not valid.
The stream is already open.
The stream has content.
Parameter charset$ is not a valid character set.

Language cross-reference

open method in Java Stream class

See examples

Examples: Open method

Library | Support | Terms of use |

Last updated: Monday, October 5, 2009