Difference between revisions of "TMPNAM()"

From Recital Documentation Wiki
Jump to: navigation, search
(Syntax)
 
(8 intermediate revisions by 2 users not shown)
Line 4: Line 4:
  
 
==Syntax==
 
==Syntax==
TMPNAM( [<expC1> [,<expC2>]] )
+
TMPNAM( [<expC1> [,<expC2>]] | [<expL>])
 +
 
  
 
==See Also==
 
==See Also==
[[GETENV()]], [[GETGID()]], [[GETUID()]], [[GETPID()]], [[RAND()]]
+
[[DB_TMPDIR]], [[GETENV()]], [[GETGID()]], [[GETUID()]], [[GETPID()]], [[RAND()]], [[SET TMPDIR]], [[SET TMPNAMPATH]], [[SYS()]]
  
  
 
==Description==
 
==Description==
The TMPNAM() function returns a character string containing a unique temporary filename.  Filenames returned by the TMPNAM() function have the extension ".tmp".  The TMPNAM() function is particularly useful in multi-user applications where a unique temporary file can be created for each process.
+
The TMPNAM() function creates a temporary file and returns a character string containing the filename.  By default, filenames returned by the TMPNAM() function have the extension ".tmp".  The TMPNAM() function is particularly useful in multi-user applications where a unique temporary file can be created for each user process. The optional argument <expC1> specifies a directory where the temporary filename will created. The optional  argument <expC2> specifies a file extension to use other than the default one of '.tmp'.
 +
 
 +
Note: if <expC1> is not specified and [[SET TMPNAMPATH]] is ON (default), the file will be created in the [[DB_TMPDIR]] directory and the filename returned will include the full path.  If SET TMPNAMPATH is OFF, only the filename will be returned and the file will be created in the current directory.  This behavior can also be achieved using the optional logical parameter <expL>.  If <expL> is .F. (False), only the filename will be returned, if .T. (True), the full path will be returned.
  
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
name = tmpnam()
+
name = tmpnam( tmpdir(), ".txt")
 
report form Listing for event = "BALLET" to file &name
 
report form Listing for event = "BALLET" to file &name
 
print &name
 
print &name
 +
delete file &name
 
</code>
 
</code>
  

Latest revision as of 13:09, 10 August 2011

Purpose

Function to return temporary file name function


Syntax

TMPNAM( [<expC1> [,<expC2>]] | [<expL>])


See Also

DB_TMPDIR, GETENV(), GETGID(), GETUID(), GETPID(), RAND(), SET TMPDIR, SET TMPNAMPATH, SYS()


Description

The TMPNAM() function creates a temporary file and returns a character string containing the filename. By default, filenames returned by the TMPNAM() function have the extension ".tmp". The TMPNAM() function is particularly useful in multi-user applications where a unique temporary file can be created for each user process. The optional argument <expC1> specifies a directory where the temporary filename will created. The optional argument <expC2> specifies a file extension to use other than the default one of '.tmp'.

Note: if <expC1> is not specified and SET TMPNAMPATH is ON (default), the file will be created in the DB_TMPDIR directory and the filename returned will include the full path. If SET TMPNAMPATH is OFF, only the filename will be returned and the file will be created in the current directory. This behavior can also be achieved using the optional logical parameter <expL>. If <expL> is .F. (False), only the filename will be returned, if .T. (True), the full path will be returned.


Example

name = tmpnam( tmpdir(), ".txt")
report form Listing for event = "BALLET" to file &name
print &name
delete file &name


Products

Recital, Recital Server