diff options
author | Xavier Leroy <xavier.leroy@inria.fr> | 2001-03-29 13:13:26 +0000 |
---|---|---|
committer | Xavier Leroy <xavier.leroy@inria.fr> | 2001-03-29 13:13:26 +0000 |
commit | ad4f24ba12ef80a20eadc9ceed6be5740bfea801 (patch) | |
tree | b49ec8ac605941c6954b25a17a7c71095f702bed /stdlib/filename.mli | |
parent | 22064c466b5c39e1fa6b875cdd404250c5ac0750 (diff) | |
download | ocaml-ad4f24ba12ef80a20eadc9ceed6be5740bfea801.tar.gz |
Doc de temp_file (PR#315)
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@3477 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'stdlib/filename.mli')
-rw-r--r-- | stdlib/filename.mli | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/stdlib/filename.mli b/stdlib/filename.mli index 47b00538df..2d3bf6513b 100644 --- a/stdlib/filename.mli +++ b/stdlib/filename.mli @@ -54,9 +54,12 @@ val dirname : string -> string designate the same file as [name] before the call to [Sys.chdir]. *) val temp_file : prefix:string -> suffix:string -> string (* [temp_file prefix suffix] returns the name of a - non-existent temporary file in the temporary directory. + fresh temporary file in the temporary directory. The base name of the temporary file is formed by concatenating [prefix], then a suitably chosen integer number, then [suffix]. + The temporary file is created empty, and is guaranteed to be + different from any other file that existed when [temp_file] + was called. Under Unix, the temporary directory is [/tmp] by default; if set, the value of the environment variable [TMPDIR] is used instead. Under Windows, the name of the temporary directory is the |