modules/plugin/base/public/nsIFileUtilities.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nspluginroot.idl"
  40
  41 %{C++
  42 #include "nsplugindefs.h"
  43 %}
  44
  45 /**
  46  * The nsIFileUtilities interface provides access to random file operations.
  47  * To obtain: QueryInterface on nsIPluginManager.
  48  */
  49 [uuid(89a31ce0-019a-11d2-815b-006008119d7a)]
  50 interface nsIFileUtilities : nsISupports
  51 {
  52   /**
  53    * Returns the name of the browser executable program.
  54    *
  55    * @param aProgramPath - the returned path to the program
  56    * @result             - NS_OK if this operation was successful
  57    */
  58   void getProgramPath(out constCharPtr aProgramPath);
  59
  60   /**
  61    * Returns the name of the temporary directory.
  62    *
  63    * @param aTempDirPath - the returned path to the temp directory
  64    * @result             - NS_OK if this operation was successful
  65    */
  66   void getTempDirPath(out constCharPtr aTempDirPath);
  67
  68   /**
  69    * Returns a unique temporary file name.
  70    *
  71    * @param aPrefix - a string to prefix to the temporary file name
  72    * @param aLength - the length of the resulting buffer to receive the data
  73    * @param aBuffer - the returned temp file name
  74    * @result        - NS_OK if this operation was successful
  75    */
  76   void newTempFileName(in string aPrefix, in unsigned long aLength, in charPtr aBuffer);
  77 };