tempfile.c File Reference

GIS Library - Temporary file functions. More...

#include <string.h>
#include <unistd.h>
#include <sys/stat.h>
#include <grass/gis.h>

Include dependency graph for tempfile.c:

Go to the source code of this file.

Functions

char * G_tempfile (void)
 Returns a temporary file name.
char * G__tempfile (int pid)
 Create tempfile from process id.
int G__temp_element (char *element)
 Populates element with a path string.


Detailed Description

GIS Library - Temporary file functions.

(C) 2001-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:
GRASS GIS Development Team
Date:
1999-2008

Definition in file tempfile.c.


Function Documentation

int G__temp_element ( char *  element  ) 

Populates element with a path string.

Parameters:
[in,out] element 
Returns:
always returns 0

Definition at line 90 of file tempfile.c.

References G__machine_name(), G__make_mapset_element(), and NULL.

Referenced by G__tempfile().

char* G__tempfile ( int  pid  ) 

Create tempfile from process id.

See G_tempfile().

Parameters:
[in] pid 
Returns:
Pointer to string path

Definition at line 62 of file tempfile.c.

References G__file_name(), G__temp_element(), G_mapset(), G_store(), and name.

Referenced by G_tempfile().

char* G_tempfile ( void   ) 

Returns a temporary file name.

This routine returns a pointer to a string containing a unique temporary file name that can be used as a temporary file within the module. Successive calls to G_tempfile() will generate new names. Only the file name is generated. The file itself is not created. To create the file, the module must use standard UNIX functions which create and open files, e.g., creat() or fopen().

Successive calls will generate different names the names are of the form pid.n where pid is the programs process id number and n is a unique identifier.

Note: It is recommended to unlink() (remove) the temp file on exit/error. Only if GRASS is left with 'exit', the GIS mapset manangement will clean up the temp directory (ETC/clean_temp).

Returns:
pointer to a character string containing the name. The name is copied to allocated memory and may be released by the unix free() routine.

Definition at line 47 of file tempfile.c.

References G__tempfile().

Referenced by G_ask_datum_name(), G_ask_ellipse_name(), G_ask_proj_name(), and G_put_cell_title().


Generated on Thu Jul 16 13:20:56 2009 for GRASS Programmer's Manual by  doxygen 1.5.6