Differences

This shows you the differences between two versions of the page.

--- generate_temporary_file [2020/04/28 12:05]
argemiro created
+++ generate_temporary_file [2026/08/28 03:20] (current)
hermann Sync from local documentation review
@@ Line 1: / Line 1: @@
 ====== Generate Temporary File ======
 ===== Description =====
-Create a temporary file.
+Creates a temporary file, or simply reserves a temporary filename, guaranteeing that the name does not collide with any existing file.
 ===== Inputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| Extension  | [[string_type|String]]  | The desired extension for the generated temporary file. Extension must contain letters and numbers only.  |
+| Extension  | [[String Type]]  | Extension for the generated temporary file, without the leading period. It must contain only letters and numbers.  |
 ===== Optional Inputs =====
-^ Name ^ Type ^ Description ^
-| Create File | [[boolean_value_type|Boolean Value]]  | If generated filename will be created or have its path reserved only.  |
+^ Name  ^ Type  ^ Description  ^ Default Value  ^
+| Create File  | [[Boolean Value Type]]  | If true, the file is created empty on disk. If false, only its path is reserved and no file is created.  | No  |
 ===== Outputs =====
-^ Name ^ Type ^ Description ^
-| Filename | Generic Filename  | The filename of the generated temporary file.  |
+^ Name  ^ Type  ^ Description  ^
+| Filename  | [[Generic Filename Type]]  | Filename of the generated temporary file.  |
 ===== Group =====
-[[Functor List#Control | Control]]
+[[Functor List#Input / Output | Input / Output]]
-===== Internal Name =====
+===== Notes =====
-GenerateTemporaryFile
+Extension must contain only letters and numbers. Providing an extension with any other character raises an error.
+===== Internal Name =====
+GenerateTemporaryFile