.\" Process this file with
.\" groff -man -Tascii cryptday.1
.\"
.TH js_open_read 3 "August 2000" JS "js library reference"
.\" We don't want hyphenation (it's too ugly)
.\" We also disable justification when using nroff
.hy 0
.if n .na
.SH NAME
js_open_read \- Open up a file for reading
.SH SYNOPSIS
.nf
.B #include "JsStr.h"
.sp
.B "int js_open_read(js_string *filename,js_file *desc)"
.fi
.SH DESCRIPTION
.B js_open_read
is a function that opens up a file for reading, using the
contents in the
.I js_string
object
.B filename
to determine the file name.

.B desc 
is where we store the opened file descriptor.
.SH "RETURN VALUE"
.B js_open_read
returns JS_ERROR if an error happened opening the file, JS_SUCCESS otherwise.
The member 
.I filetype
of the structure
.I desc
will have an invalid value if an error occured opening the file.
.SH EXAMPLE
The following opens up the file "filename" for reading:

.nf
	js_string *foo;
	js_file *bar;
	foo = js_create(256,1);		
	js_str2js(foo,"filename",8,1);
	js_open_read(foo,bar); 
.fi
.SH AUTHOR
Sam Trenholme <kiwi-zttfryb@koala.samiam.org>