Back to index

lightning-sunbird  0.9+nobinonly
mozIStorageValueArray.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Oracle Corporation code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  *  Oracle Corporation
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 [ptr] native octetPtr(PRUint8);
00042 
00047 [scriptable, uuid(07b5b93e-113c-4150-863c-d247b003a55d)]
00048 interface mozIStorageValueArray : nsISupports {
00054   const long VALUE_TYPE_NULL = 0;
00055   const long VALUE_TYPE_INTEGER = 1;
00056   const long VALUE_TYPE_FLOAT = 2;
00057   const long VALUE_TYPE_TEXT = 3;
00058   const long VALUE_TYPE_BLOB = 4;
00059 
00066   readonly attribute unsigned long numEntries;
00067 
00073   long getTypeOfIndex(in unsigned long aIndex);
00074 
00087   long getInt32(in unsigned long aIndex);
00088   long long getInt64(in unsigned long aIndex);
00089   double getDouble(in unsigned long aIndex);
00090   AUTF8String getUTF8String(in unsigned long aIndex);
00091   AString getString(in unsigned long aIndex);
00092 
00093   // data will be NULL if dataSize = 0
00094   void getBlob(in unsigned long aIndex, out unsigned long aDataSize, [array,size_is(aDataSize)] out octet aData);
00095   boolean getIsNull(in unsigned long aIndex);
00096 
00100   [noscript] void getSharedUTF8String(in unsigned long aIndex, out unsigned long aLength, [shared,retval] out string aResult);
00101   [noscript] void getSharedString(in unsigned long aIndex, out unsigned long aLength, [shared,retval] out wstring aResult);
00102   [noscript] void getSharedBlob(in unsigned long aIndex, out unsigned long aLength, [shared,retval] out octetPtr aResult);
00103 
00104 %{C++
00112   inline PRInt32 AsInt32(PRUint32 idx) {
00113     PRInt32 v;
00114     GetInt32(idx, &v);
00115     return v;
00116   }
00117 
00118   inline PRInt64 AsInt64(PRUint32 idx) {
00119     PRInt64 v;
00120     GetInt64(idx, &v);
00121     return v;
00122   }
00123 
00124   inline double AsDouble(PRUint32 idx) {
00125     double v;
00126     GetDouble(idx, &v);
00127     return v;
00128   }
00129 
00130   inline const char* AsSharedUTF8String(PRUint32 idx, PRUint32 *len) {
00131     const char *str = nsnull;
00132     GetSharedUTF8String(idx, len, &str);
00133     return str;
00134   }
00135 
00136   inline const PRUnichar* AsSharedWString(PRUint32 idx, PRUint32 *len) {
00137     const PRUnichar *str = nsnull;
00138     GetSharedString(idx, len, &str);
00139     return str;
00140   }
00141 
00142   inline const PRUint8* AsSharedBlob(PRUint32 idx, PRUint32 *len) {
00143     const PRUint8 *blob = nsnull;
00144     GetSharedBlob(idx, len, &blob);
00145     return blob;
00146   }
00147 
00148   inline PRBool IsNull(PRUint32 idx) {
00149     PRBool b = PR_FALSE;
00150     GetIsNull(idx, &b);
00151     return b;
00152   }
00153 
00154 %}
00155 
00156 };