Summary
The NS_CStringToUTF16
function converts the value of a nsACString
instance to UTF-16 and stores the result in a nsAString
instance.
#include "nsStringAPI.h"
nsresult NS_CStringToUTF16( const nsACString& aSrc, nsCStringEncoding aSrcEncoding, nsAString& aDest );
Parameters
- aSrc
- [in] A
nsACString
instance containing the source string to be converted.
- aSrcEncoding
- [in] The character encoding of the source string. See
nsCStringEncoding
for the set of values that can be passed for this parameter.
- aDest
- [out] A
nsAString
instance that will contain the result of the conversion. The result will be encoded using the host byte order.
Return Values
The NS_CStringToUTF16
function returns NS_OK
if successful. Otherwise, it returns an error code. The set of possible error codes is currently unspecified.
Example Code
nsEmbedCString str("hello"); nsEmbedString ustr; NS_CStringToUTF16(str, NS_CSTRING_ENCODING_ASCII, ustr); const PRUnichar *unicharBuf = ustr.get();
History
This function was frozen for Mozilla 1.7. See bug bug 239123 for details.