BINOPEN()

From Recital Documentation Wiki
Revision as of 16:07, 26 November 2009 by Helengeorge (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Purpose

Function to open a binary file


Syntax

BINOPEN([<expC>,<expN>])


See Also

BIN2I(), BIN2L(), BIN2W(), BINCLOSE(), BINCREATE(), BINREAD(), BINSEEK(), BINWRITE(), FCLOSE(), FOPEN(), I2BIN(), L2BIN()


Description

The BINOPEN() function opens an existing binary file. The <expC> is the name of the file to be opened. The <expN> is the mode in which the file will be opened. The open mode options are:


Mode Description
0 Read-only
1 Write-only
2 Read/write


BINOPEN() returns a file descriptor if it has opened the file successfully, or a -1 if unsuccessful. Since the file descriptor is used to identify open binary files, the BINOPEN() return value should always be assigned to a memory variable. The binary conversion functions may be used in conjunction with the binary file functions.


Example

fd = binopen("file.obj")
count = binread(fd, 4)
count = bin2l(count)
count = l2bin(count + 1)
binseek(fd, 512, 0)
binwrite(fd, count)
binclose(fd)


Products

Recital Server, Recital