GRASS Programmer's Manual  6.4.1(2011)
open.c File Reference

GIS Library - open file functions. More...

#include <grass/config.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <grass/gis.h>
#include <grass/glocale.h>
Include dependency graph for open.c:

Go to the source code of this file.

Functions

int G_open_new (const char *element, const char *name)
 Open a new database file.
int G_open_old (const char *element, const char *name, const char *mapset)
 Open a database file for reading.
int G_open_update (const char *element, const char *name)
 Open a database file for update.
FILE * G_fopen_new (const char *element, const char *name)
 Open a new database file.
FILE * G_fopen_old (const char *element, const char *name, const char *mapset)
 Open a database file for reading.
FILE * G_fopen_append (const char *element, const char *name)
 Open a database file for update (append mode)
FILE * G_fopen_modify (const char *element, const char *name)
 Open a database file for update (r+ mode)

Detailed Description

GIS Library - open file functions.

(C) 1999-2008 by the GRASS Development Team

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author:
USACERL and many others

Definition in file open.c.


Function Documentation

FILE* G_fopen_append ( const char *  element,
const char *  name 
)

Open a database file for update (append mode)

The database file name under the element in the current mapset is opened for for writing. The UNIX fopen() routine, with "a" append mode, is used to open the file. If the file does not exist, the NULL pointer is returned. Otherwise the file descriptor from the fopen() is returned.

Parameters:
elementdatabase element name
namemap file name
Returns:
open file descriptor (FILE *)
NULL could not open

Definition at line 252 of file open.c.

References G_mapset().

FILE* G_fopen_modify ( const char *  element,
const char *  name 
)

Open a database file for update (r+ mode)

The database file name under the element in the current mapset is opened for for writing. The UNIX fopen() routine, with "r+" append mode, is used to open the file. If the file does not exist, the NULL pointer is returned. Otherwise the file descriptor from the fopen() is returned.

Parameters:
elementdatabase element name
namemap file name
Returns:
open file descriptor (FILE *)
NULL

Definition at line 279 of file open.c.

References G_mapset().

FILE* G_fopen_new ( const char *  element,
const char *  name 
)

Open a new database file.

The database file name under the element in the current mapset is created and opened for writing (but not reading). The UNIX fopen() routine, with "w" write mode, is used to open the file. If the file does not exist, the NULL pointer is returned. Otherwise the file is positioned at the end of the file and the file descriptor from the fopen() is returned.

Parameters:
elementdatabase element name
namemap file name
Returns:
open file descriptor (FILE *)
NULL could not open

Definition at line 197 of file open.c.

References G_mapset().

Referenced by G__put_window(), G__quant_export(), G__write_cats(), G_put_3dview(), G_put_cell_title(), G_put_cellhd(), G_write_colors(), and G_write_history().

FILE* G_fopen_old ( const char *  element,
const char *  name,
const char *  mapset 
)

Open a database file for reading.

The database file name under the element in the specified mapset is opened for reading (but not for writing). The UNIX fopen() routine, with "r" read mode, is used to open the file. If the file does not exist, the NULL pointer is returned. Otherwise the file descriptor from the fopen() is returned.

Parameters:
elementdatabase element name
namemap file name
mapsetmapset name containing map name
Returns:
open file descriptor (FILE *)
NULL could not open

Definition at line 226 of file open.c.

Referenced by G__get_window(), G__quant_import(), G__read_cats(), G_get_3dview(), G_get_cell_title(), G_get_cellhd(), G_get_dig_title(), G_put_cell_title(), and G_read_history().

int G_open_new ( const char *  element,
const char *  name 
)

Open a new database file.

Creates name in the current mapset and opens it for write only.

The database file name under the element in the current mapset is created and opened for writing (but not reading). The UNIX open() routine is used to open the file. If the file does not exist, -1 is returned. Otherwise the file is positioned at the end of the file and the file descriptor from the open() is returned.

Parameters:
elementdatabase element name
namemap file name
Returns:
open file descriptor (int)
-1 could not open

Definition at line 125 of file open.c.

References G_mapset().

Referenced by G_write_fp_range().

int G_open_old ( const char *  element,
const char *  name,
const char *  mapset 
)

Open a database file for reading.

The database file name under the element in the specified mapset is opened for reading (but not for writing). The UNIX open() routine is used to open the file. If the file does not exist, -1 is returned. Otherwise the file descriptor from the open() is returned.

Parameters:
elementdatabase element name
namemap file name
mapsetmapset containing map name
Returns:
open file descriptor (int)
-1 could not open

Definition at line 147 of file open.c.

Referenced by G__open_cell_old().

int G_open_update ( const char *  element,
const char *  name 
)

Open a database file for update.

The database file name under the element in the current mapset is opened for reading and writing. The UNIX open() routine is used to open the file. If the file does not exist, -1 is returned. Otherwise the file is positioned at the end of the file and the file descriptor from the open() is returned.

Parameters:
elementdatabase element name
namemap file name
Returns:
open file descriptor (int)
-1 could not open

Definition at line 168 of file open.c.

References G_mapset().

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines