Public Member Functions

nsIErrorService Interface Reference

nsIErrorService: This is an interim service that allows nsresult codes to be mapped to string bundles that can be used to look up error messages. More...

import "nsIErrorService.idl";

List of all members.

Public Member Functions

void registerErrorStringBundle (in short errorModule, in string stringBundleURL)
 Registers a string bundle URL for an error module.
void unregisterErrorStringBundle (in short errorModule)
 Registers a string bundle URL for an error module.
string getErrorStringBundle (in short errorModule)
 Retrieves a string bundle URL for an error module.
void registerErrorStringBundleKey (in nsresult error, in string stringBundleKey)
 Registers a key in a string bundle for an nsresult error code.
void unregisterErrorStringBundleKey (in nsresult error)
 Unregisters a key in a string bundle for an nsresult error code.
string getErrorStringBundleKey (in nsresult error)
 Retrieves a key in a string bundle for an nsresult error code.

Detailed Description

nsIErrorService: This is an interim service that allows nsresult codes to be mapped to string bundles that can be used to look up error messages.

String bundle keys can also be mapped.

This service will eventually get replaced by extending xpidl to allow errors to be defined. (http://bugzilla.mozilla.org/show_bug.cgi?id=13423).


Member Function Documentation

string nsIErrorService::getErrorStringBundle ( in short  errorModule  ) 

Retrieves a string bundle URL for an error module.

string nsIErrorService::getErrorStringBundleKey ( in nsresult  error  ) 

Retrieves a key in a string bundle for an nsresult error code.

If no key is registered for the specified nsresult's code (obtained with NS_ERROR_GET_CODE), then the stringified version of the nsresult code is returned.

void nsIErrorService::registerErrorStringBundle ( in short  errorModule,
in string  stringBundleURL 
)

Registers a string bundle URL for an error module.

Error modules are obtained from nsresult code with NS_ERROR_GET_MODULE.

void nsIErrorService::registerErrorStringBundleKey ( in nsresult  error,
in string  stringBundleKey 
)

Registers a key in a string bundle for an nsresult error code.

Only the code portion of the nsresult is used (obtained with NS_ERROR_GET_CODE) in this registration. The string bundle key is used to look up internationalized messages in the string bundle.

void nsIErrorService::unregisterErrorStringBundle ( in short  errorModule  ) 

Registers a string bundle URL for an error module.

void nsIErrorService::unregisterErrorStringBundleKey ( in nsresult  error  ) 

Unregisters a key in a string bundle for an nsresult error code.


The documentation for this interface was generated from the following file: