xpcom/io/nsAnonymousTemporaryFile.h@6474c204b198 (annotated)
xpcom/io/nsAnonymousTemporaryFile.h
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* vim:set ts=2 sw=2 sts=2 et cindent: */ |
| michael@0 | 3 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 4 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 5 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 6 | |
| michael@0 | 7 | #pragma once |
| michael@0 | 8 | |
| michael@0 | 9 | #include "prio.h" |
| michael@0 | 10 | #include "nscore.h" |
| michael@0 | 11 | |
| michael@0 | 12 | /** |
| michael@0 | 13 | * OpenAnonymousTemporaryFile |
| michael@0 | 14 | * |
| michael@0 | 15 | * Creates and opens a temporary file which has a random name. Callers have no |
| michael@0 | 16 | * control over the file name, and the file is opened in a temporary location |
| michael@0 | 17 | * which is appropriate for the platform. |
| michael@0 | 18 | * |
| michael@0 | 19 | * Upon success, aOutFileDesc contains an opened handle to the temporary file. |
| michael@0 | 20 | * The caller is responsible for closing the file when they're finished with it. |
| michael@0 | 21 | * |
| michael@0 | 22 | * The file will be deleted when the file handle is closed. On non-Windows |
| michael@0 | 23 | * platforms the file will be unlinked before this function returns. On Windows |
| michael@0 | 24 | * the OS supplied delete-on-close mechanism is unreliable if the application |
| michael@0 | 25 | * crashes or the computer power cycles unexpectedly, so unopened temporary |
| michael@0 | 26 | * files are purged at some time after application startup. |
| michael@0 | 27 | * |
| michael@0 | 28 | */ |
| michael@0 | 29 | nsresult |
| michael@0 | 30 | NS_OpenAnonymousTemporaryFile(PRFileDesc** aOutFileDesc); |
| michael@0 | 31 |
