gecko/modules/plugin/base/public/nsIFileUtilities.idl

78 lines
2.9 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
#include "nspluginroot.idl"
%{C++
#include "nsplugindefs.h"
%}
/**
* The nsIFileUtilities interface provides access to random file operations.
* To obtain: QueryInterface on nsIPluginManager.
*/
[uuid(89a31ce0-019a-11d2-815b-006008119d7a)]
interface nsIFileUtilities : nsISupports
{
/**
* Returns the name of the browser executable program.
*
* @param aProgramPath - the returned path to the program
* @result - NS_OK if this operation was successful
*/
void getProgramPath(out constCharPtr aProgramPath);
/**
* Returns the name of the temporary directory.
*
* @param aTempDirPath - the returned path to the temp directory
* @result - NS_OK if this operation was successful
*/
void getTempDirPath(out constCharPtr aTempDirPath);
/**
* Returns a unique temporary file name.
*
* @param aPrefix - a string to prefix to the temporary file name
* @param aLength - the length of the resulting buffer to receive the data
* @param aBuffer - the returned temp file name
* @result - NS_OK if this operation was successful
*/
void newTempFileName(in string aPrefix, in unsigned long aLength, in charPtr aBuffer);
};