mozIStorageProgressHandler

From MDC

The mozIStorageProgressHandler interface lets storage consumers receive callbacks during the execution of sqlite requests.

Contents 1 Method overview 2 Methods 2.1 onProgress() 2.1.1 Parameters 2.1.2 Return value 3 See also

mozIStorageProgressHandler is defined in storage/public/mozIStorageProgressHandler.idl. It is scriptable and unfrozen (hasn't changed since Mozilla 1.8).

Inherits from: nsISupports

[edit] Method overview

boolean onProgress(in mozIStorageConnection aConnection);

[edit] Methods

[edit] onProgress()

The onProgress() method is called periodically while an sqlite operation is ongoing. This allows you to monitor the progress and possibly display status information to the user.

 boolean onProgress(
   in mozIStorageConnection aConnection
 );

[edit] Parameters

aConnection

A mozIStorageConnection connection indicating the connection for which the callback was invoked.

[edit] Return value

Return true to abort the request or false to allow it to continue.

[edit] See also

• Storage mozStorage introduction and how-to article
• mozIStorageConnection Database connection to a specific file or in-memory data storage
• mozIStorageStatement Create and execute SQL statements on a SQLite database.
• mozIStorageValueArray Wraps an array of SQL values, such as a result row.
• mozIStorageFunction Create a new SQLite function.
• mozIStorageAggregateFunction Create a new SQLite aggregate function.
• mozIStorageStatementWrapper Storage statement wrapper