xpcom/io/nsILocalFileWin.idl

   1 /* -*- Mode: Java; 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 the Local File Interface (Windows Extensions).
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Ben Goodger <ben@mozilla.org> (Original Author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK *****
  38  */
  39
  40 #include "nsILocalFile.idl"
  41
  42 [scriptable, uuid(def24611-88a1-2cac-74fd-4b0b12bcaed5)]
  43 interface nsILocalFileWin : nsILocalFile
  44 {
  45    /**
  46     * getVersionInfoValue
  47     *
  48     * Retrieve a metadata field from the file's VERSIONINFO block.
  49     * Throws NS_ERROR_FAILURE if no value is found, or the value is empty.
  50     *
  51     * @param   aField         The field to look up.
  52     *
  53     */
  54     AString getVersionInfoField(in string aField);
  55
  56     /**
  57      * The canonical path of the file, which avoids short/long
  58      * pathname inconsistencies. The nsILocalFile persistent
  59      * descriptor is not guaranteed to be canonicalized (it may
  60      * persist either the long or the short path name). The format of
  61      * the canonical path will vary with the underlying file system:
  62      * it will typically be the short pathname on filesystems that
  63      * support both short and long path forms.
  64      */
  65     readonly attribute AString canonicalPath;
  66     [noscript] readonly attribute ACString nativeCanonicalPath;
  67
  68     /**
  69      * Windows specific file attributes.
  70      *
  71      * WFA_SEARCH_INDEXED: Generally the default on files in Windows except
  72      * those created in temp locations. Valid on XP and up. When set the
  73      * file or directory is marked to be indexed by desktop search services.
  74      */
  75     const unsigned long WFA_SEARCH_INDEXED = 1;
  76
  77     /**
  78      * fileAttributesWin
  79      *
  80      * Set or get windows specific file attributes.
  81      *
  82      * Throws NS_ERROR_FILE_INVALID_PATH for an invalid file.
  83      * Throws NS_ERROR_FAILURE if the set or get fails.
  84      */
  85     attribute unsigned long fileAttributesWin;
  86 };
  87