mozilla

Revision 128605 of mozIStorageBindingParams

  • Revision slug: mozIStorageBindingParams
  • Revision title: mozIStorageBindingParams
  • Revision id: 128605
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment 17 words added

Revision Content

{{ gecko_minversion_header("1.9.2") }}

The mozIStorageBindingParams interface is used to bind values to parameters prior to calling {{ ifmethod("mozIStorageStatement", "executeAsync") }}.

{{ InterfaceStatus("mozIStorageBindingParams", "storage/public/mozIStorageBindingParams.idl", "unfrozen", "Mozilla 1.9.2", "yes") }}

Inherits from: {{ Interface("nsISupports") }}

You should only create mozIStorageBindingParams objects by calling the {{ ifandmethod("mozIStorageBindingParamsArray", "newBindingParams") }}.

Method overview

void bindByIndex(in unsigned long aIndex, in {{ interface("nsIVariant") }} aValue);
void bindBlobByIndex(in unsigned long aIndex, [array, const, size_is(aValueSize)] in octet aValue, in unsigned long aValueSize);
void bindDoubleByIndex(in unsigned long aIndex, in double aValue); {{ noscript_inline() }}
void bindInt32ByIndex(in unsigned long aIndex, in long aValue); {{ noscript_inline() }}
void bindInt64ByIndex(in unsigned long aIndex, in long long aValue); {{ noscript_inline() }}
void bindNullByIndex(in unsigned long aIndex); {{ noscript_inline() }}
void bindStringByIndex(in unsigned long aIndex, in AString aValue); {{ noscript_inline() }}
void bindUTF8StringByIndex(in unsigned long aIndex, in AUTF8String aValue); {{ noscript_inline() }}
void bindByName(in AUTF8String aName, in {{ interface("nsIVariant") }} aValue);
void bindBlobByName(in AUTF8String aName, [array, const, size_is(aValueSize)] in octet aValue, in unsigned long aValueSize);
void bindDoubleByName(in AUTF8String aName, in double aValue); {{ noscript_inline() }}
void bindInt32ByName(in AUTF8String aName, in long aValue); {{ noscript_inline() }}
void bindInt64ByName(in AUTF8String aName, in long long aValue); {{ noscript_inline() }}
void bindNullByName(in AUTF8String aName); {{ noscript_inline() }}
void bindStringByName(in AUTF8String aName, in AString aValue); {{ noscript_inline() }}
void bindUTF8StringByName(in AUTF8String aName, in AUTF8String aValue); {{ noscript_inline() }}

Methods

bindByIndex()

Binds a value to a parameter with the specified index.

void bindByIndex(
  in unsigned long aIndex,
  in nsIVariant aValue
);
Parameters
aIndex
The index of the parameter to which to bind a value.
aValue
The value to bind to the specified parameter.

bindBlobByIndex()

Binds a blob of data to a parameter with the specified index.

void bindBlobByIndex(
  in unsigned long aIndex,
  [array, const, size_is(aValueSize)] in octet aValue,
  in unsigned long aValueSize
);
Parameters
aIndex
The index of the parameter to which to bind the blob of data.
aValue
An array of aValueSize bytes of data to bind to the parameter.
aValueSize
The number of bytes of data in the blob.

{{ method_noscript("bindDoubleByIndex") }}

Binds a double to a parameter with the specified index.

void bindDoubleByIndex(
  in unsigned long aIndex,
  in double aValue
);
Parameters
aIndex
The index of the parameter to which to bind a value.
aValue
The double-precision value to bind to the specified parameter.

{{ method_noscript("bindInt32ByIndex") }}

Binds a 32-bit integer value to a parameter with the specified index.

void bindInt32ByIndex(
  in unsigned long aIndex,
  in long aValue
);
Parameters
aIndex
The index of the parameter to which to bind a value.
aValue
The 32-bit integer value to bind to the specified parameter.

{{ method_noscript("bindInt64ByIndex") }}

Binds a 64-bit integer value to a parameter with the specified index.

void bindInt32ByIndex(
  in unsigned long aIndex,
  in long long aValue
);
Parameters
aIndex
The index of the parameter to which to bind a value.
aValue
The 64-bit integer value to bind to the specified parameter.

{{ method_noscript("bindNullByIndex") }}

Nullfies the binding for the parameter with the specified index.

void bindNullByIndex(
  in unsigned long aIndex
);
Parameters
aIndex
The index of the parameter which should have no value.

{{ method_noscript("bindStringByIndex") }}

Binds a string value to a parameter with the specified index.

void bindStringByIndex(
  in unsigned long aIndex,
  in AString aValue
);
Parameters
aIndex
The index of the parameter to which to bind a value.
aValue
The string to bind to the specified parameter.

{{ method_noscript("bindUTF8StringByIndex") }}

Binds a UTF-8 encoded string to a parameter with the specified index.

void bindStringByIndex(
  in unsigned long aIndex,
  in AUTF8String aValue
);
Parameters
aIndex
The index of the parameter to which to bind a value.
aValue
The UTF-8 string to bind to the specified parameter.

bindByName()

Binds a value to a parameter with the specified name.

void bindByName(
  in AUTF8String aName,
  in nsIVariant aValue
);
Parameters
aName
The name of the parameter to which to bind a value.
aValue
The value to bind to the specified parameter.

bindBlobByName()

Binds a blob of data to a parameter with the specified name.

void bindBlobByName(
  in AUTF8String aName,
  [array, const, size_is(aValueSize)] in octet aValue,
  in unsigned long aValueSize
);
Parameters
aName
The name of the parameter to which to bind the blob of data.
aValue
The data to bind to the specified parameter.
aValueSize
The number of bytes of data in the blob specified by aValue.

{{ method_noscript("bindDoubleByName") }}

Binds a double to a parameter with the specified name.

void bindDoubleByName(
  in AUTF8String aName,
  in double aValue
);
Parameters
aName
The name of the parameter to which to bind a value.
aValue
The double-precision value to bind to the specified parameter.

{{ method_noscript("bindInt32ByName") }}

Binds a 32-bit integer value to a parameter with the specified name.

void bindInt32ByName(
  in AUTF8String aName,
  in long aValue
);
Parameters
aName
The name of the parameter to which to bind a value.
aValue
The 32-bit integer value to bind to the specified parameter.

{{ method_noscript("bindInt64ByName") }}

Binds a 64-bit integer value to a parameter with the specified name.

void bindInt32ByName(
  in AUTF8String aName,
  in long long aValue
);
Parameters
aName
The name of the parameter to which to bind a value.
aValue
The 64-bit integer value to bind to the specified parameter.

{{ method_noscript("bindNullByName") }}

Nullfies the binding for the parameter with the specified name.

void bindNullByName(
  in AUTF8String aName
);
Parameters
aName
The name of the parameter which should have no value.

{{ method_noscript("bindStringByName") }}

Binds a string value to a parameter with the specified name.

void bindStringByName(
  in AUTF8String aName,
  in AString aValue
);
Parameters
aName
The name of the parameter to which to bind a value.
aValue
The string to bind to the specified parameter.

{{ method_noscript("bindUTF8StringByName") }}

Binds a UTF-8 encoded string to a parameter with the specified name.

void bindStringByName(
  in AUTF8String aName,
  in AUTF8String aValue
);
Parameters
aName
The name of the parameter to which to bind a value.
aValue
The UTF-8 string to bind to the specified parameter.

See also

Revision Source

<p>{{ gecko_minversion_header("1.9.2") }}</p>
<p>The <code>mozIStorageBindingParams</code> interface is used to bind values to parameters prior to calling {{ ifmethod("mozIStorageStatement", "executeAsync") }}.</p>
<p>{{ InterfaceStatus("mozIStorageBindingParams", "storage/public/mozIStorageBindingParams.idl", "unfrozen", "Mozilla 1.9.2", "yes") }}</p>
<p>Inherits from: {{ Interface("nsISupports") }}</p>
<p>You should only create <code>mozIStorageBindingParams</code> objects by calling the {{ ifandmethod("mozIStorageBindingParamsArray", "newBindingParams") }}.</p>
<h2 name="Method_overview">Method overview</h2>
<table class="standard-table"> <tbody> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindByIndex()" title="En/mozIStorageBindingParams#bindByIndex()">bindByIndex</a>(in unsigned long aIndex, in {{ interface("nsIVariant") }} aValue);</code></td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindBlobByIndex()" title="En/mozIStorageBindingParams#bindBlobByIndex()">bindBlobByIndex</a>(in unsigned long aIndex, [array, const, size_is(aValueSize)] in octet aValue, in unsigned long aValueSize);</code></td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindDoubleByIndex()" title="En/mozIStorageBindingParams#bindDoubleByIndex()">bindDoubleByIndex</a>(in unsigned long aIndex, in double aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindInt32ByIndex()" title="En/mozIStorageBindingParams#bindInt32ByIndex()">bindInt32ByIndex</a>(in unsigned long aIndex, in long aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindInt64ByIndex()" title="En/mozIStorageBindingParams#bindInt64ByIndex()">bindInt64ByIndex</a>(in unsigned long aIndex, in long long aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindNullByIndex()" title="En/mozIStorageBindingParams#bindNullByIndex()">bindNullByIndex</a>(in unsigned long aIndex);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindStringByIndex()" title="En/mozIStorageBindingParams#bindStringByIndex()">bindStringByIndex</a>(in unsigned long aIndex, in AString aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindUTF8StringByIndex()" title="En/mozIStorageBindingParams#bindUTF8StringByIndex()">bindUTF8StringByIndex</a>(in unsigned long aIndex, in AUTF8String aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindByName()" title="En/mozIStorageBindingParams#bindByName()">bindByName</a>(in AUTF8String aName, in {{ interface("nsIVariant") }} aValue);</code></td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindBlobByName()" title="En/mozIStorageBindingParams#bindBlobByName()">bindBlobByName</a>(in AUTF8String aName, [array, const, size_is(aValueSize)] in octet aValue, in unsigned long aValueSize);</code></td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindDoubleByName()" title="En/mozIStorageBindingParams#bindDoubleByName()">bindDoubleByName</a>(in AUTF8String aName, in double aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindInt32ByName()" title="En/mozIStorageBindingParams#bindInt32ByName()">bindInt32ByName</a>(in AUTF8String aName, in long aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindInt64ByName()" title="En/mozIStorageBindingParams#bindInt64ByName()">bindInt64ByName</a>(in AUTF8String aName, in long long aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindNullByName()" title="En/mozIStorageBindingParams#bindNullByName()">bindNullByName</a>(in AUTF8String aName);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindStringByName()" title="En/mozIStorageBindingParams#bindStringByName()">bindStringByName</a>(in AUTF8String aName, in AString aValue);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>void <a href="/en/mozIStorageBindingParams#bindUTF8StringByName()" title="En/mozIStorageBindingParams#bindUTF8StringByName()">bindUTF8StringByName</a>(in AUTF8String aName, in AUTF8String aValue);</code> {{ noscript_inline() }}</td> </tr> </tbody>
</table>
<h2 name="Methods">Methods</h2>
<h3 name="eatCookie.28.29">bindByIndex()</h3>
<p>Binds a value to a parameter with the specified index.</p>
<pre class="eval">void bindByIndex(
  in unsigned long aIndex,
  in nsIVariant aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The value to bind to the specified parameter.</dd>
</dl>
<h3 name="eatCookie.28.29">bindBlobByIndex()</h3>
<p>Binds a blob of data to a parameter with the specified index.</p>
<pre class="eval">void bindBlobByIndex(
  in unsigned long aIndex,
  [array, const, size_is(aValueSize)] in octet aValue,
  in unsigned long aValueSize
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter to which to bind the blob of data.</dd> <dt><code>aValue</code></dt> <dd>An array of aValueSize bytes of data to bind to the parameter.</dd> <dt><code>aValueSize</code></dt> <dd>The number of bytes of data in the blob.</dd>
</dl>
<p>{{ method_noscript("bindDoubleByIndex") }}</p>
<p>Binds a double to a parameter with the specified index.</p>
<pre class="eval">void bindDoubleByIndex(
  in unsigned long aIndex,
  in double aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The double-precision value to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindInt32ByIndex") }}</p>
<p>Binds a 32-bit integer value to a parameter with the specified index.</p>
<pre class="eval">void bindInt32ByIndex(
  in unsigned long aIndex,
  in long aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The 32-bit integer value to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindInt64ByIndex") }}</p>
<p>Binds a 64-bit integer value to a parameter with the specified index.</p>
<pre class="eval">void bindInt32ByIndex(
  in unsigned long aIndex,
  in long long aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The 64-bit integer value to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindNullByIndex") }}</p>
<p>Nullfies the binding for the parameter with the specified index.</p>
<pre class="eval">void bindNullByIndex(
  in unsigned long aIndex
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter which should have no value.</dd>
</dl>
<p>{{ method_noscript("bindStringByIndex") }}</p>
<p>Binds a string value to a parameter with the specified index.</p>
<pre class="eval">void bindStringByIndex(
  in unsigned long aIndex,
  in AString aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The string to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindUTF8StringByIndex") }}</p>
<p>Binds a UTF-8 encoded string to a parameter with the specified index.</p>
<pre class="eval">void bindStringByIndex(
  in unsigned long aIndex,
  in AUTF8String aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aIndex</code></dt> <dd>The index of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The UTF-8 string to bind to the specified parameter.</dd>
</dl>
<h3 name="eatCookie.28.29">bindByName()</h3>
<p>Binds a value to a parameter with the specified name.</p>
<pre class="eval">void bindByName(
  in AUTF8String aName,
  in nsIVariant aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The value to bind to the specified parameter.</dd>
</dl>
<h3 name="eatCookie.28.29">bindBlobByName()</h3>
<p>Binds a blob of data to a parameter with the specified name.</p>
<pre class="eval">void bindBlobByName(
  in AUTF8String aName,
  [array, const, size_is(aValueSize)] in octet aValue,
  in unsigned long aValueSize
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter to which to bind the blob of data.</dd> <dt><code>aValue</code></dt> <dd>The data to bind to the specified parameter.</dd> <dt><code>aValueSize</code></dt> <dd>The number of bytes of data in the blob specified by <code>aValue</code>.</dd>
</dl>
<p>{{ method_noscript("bindDoubleByName") }}</p>
<p>Binds a double to a parameter with the specified name.</p>
<pre class="eval">void bindDoubleByName(
  in AUTF8String aName,
  in double aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The double-precision value to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindInt32ByName") }}</p>
<p>Binds a 32-bit integer value to a parameter with the specified name.</p>
<pre class="eval">void bindInt32ByName(
  in AUTF8String aName,
  in long aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The 32-bit integer value to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindInt64ByName") }}</p>
<p>Binds a 64-bit integer value to a parameter with the specified name.</p>
<pre class="eval">void bindInt32ByName(
  in AUTF8String aName,
  in long long aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The 64-bit integer value to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindNullByName") }}</p>
<p>Nullfies the binding for the parameter with the specified name.</p>
<pre class="eval">void bindNullByName(
  in AUTF8String aName
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter which should have no value.</dd>
</dl>
<p>{{ method_noscript("bindStringByName") }}</p>
<p>Binds a string value to a parameter with the specified name.</p>
<pre class="eval">void bindStringByName(
  in AUTF8String aName,
  in AString aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The string to bind to the specified parameter.</dd>
</dl>
<p>{{ method_noscript("bindUTF8StringByName") }}</p>
<p>Binds a UTF-8 encoded string to a parameter with the specified name.</p>
<pre class="eval">void bindStringByName(
  in AUTF8String aName,
  in AUTF8String aValue
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>aName</code></dt> <dd>The name of the parameter to which to bind a value.</dd> <dt><code>aValue</code></dt> <dd>The UTF-8 string to bind to the specified parameter.</dd>
</dl>
<h2>See also</h2>
<ul> <li><a href="/en/Storage#Binding_multiple_parameters" title="en/Storage#Binding multiple parameters">Binding multiple parameters</a></li> <li>{{ interface("mozIStorageBindingParamsArray") }}</li> <li>{{ interface("mozIStorageStatement") }}</li>
</ul>
Revert to this revision