michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* vim:set ts=2 sw=2 sts=2 et cindent: */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #pragma once
michael@0: 
michael@0: #include "prio.h"
michael@0: #include "nscore.h"
michael@0: 
michael@0: /**
michael@0:  * OpenAnonymousTemporaryFile
michael@0:  *
michael@0:  * Creates and opens a temporary file which has a random name. Callers have no
michael@0:  * control over the file name, and the file is opened in a temporary location
michael@0:  * which is appropriate for the platform.
michael@0:  *
michael@0:  * Upon success, aOutFileDesc contains an opened handle to the temporary file.
michael@0:  * The caller is responsible for closing the file when they're finished with it.
michael@0:  *
michael@0:  * The file will be deleted when the file handle is closed. On non-Windows
michael@0:  * platforms the file will be unlinked before this function returns. On Windows
michael@0:  * the OS supplied delete-on-close mechanism is unreliable if the application
michael@0:  * crashes or the computer power cycles unexpectedly, so unopened temporary
michael@0:  * files are purged at some time after application startup.
michael@0:  *
michael@0:  */ 
michael@0: nsresult
michael@0: NS_OpenAnonymousTemporaryFile(PRFileDesc** aOutFileDesc);
michael@0: