nsIPrefLocalizedString

IID:ae419e24-1dd1-11b2-b39a-d3e5e7073802
Inherits From:nsISupports
Status:FROZEN

The nsIPrefLocalizedString interface is simply a wrapper interface for nsISupportsString so the preferences service can have a unique identifier to distinguish between requests for normal wide strings (nsISupportsString) and "localized" wide strings, which get their default values from properites files.

This interface is implemented by the following components:


Properties

PRUnichar* data

Provides access to string data stored in this property.


Methods

void setDataWithLength ( PRUint32 length , PRUnichar* data ) PRUnichar* toString ( )

void setDataWithLength ( PRUint32 length , PRUnichar* data )

Used to set the contents of this object.

Arguments:
length: The length of the string. This value should not include space for the null terminator, nor should it account for the size of a character. It should only be the number of characters for which there is space in the string.
data: The string data to be stored.
Returns:
NS_OK The data was successfully stored.

PRUnichar* toString ( )

Used to retrieve the contents of this object into a wide string.

Returns:
wstring The string containing the data stored within this object.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com