This is an archived page. It's not actively maintained.

nsAString (External)

Class Declaration

This header provides wrapper classes around the frozen string API
which are roughly equivalent to the internal string classes.

<map id="classes" name="classes"> <area alt="" coords="963,6,1045,54" href="http://developer.mozilla.org/en/nsAString_(External)" shape="rect" title="nsAString_(External)"> <area alt="" coords="939,102,1069,150" href="http://developer.mozilla.org/en/nsStringContainer_(External)" shape="rect" title="nsStringContainer_(External)"> <area alt="" coords="548,198,676,246" href="http://developer.mozilla.org/en/nsString_external" shape="rect" title="nsString_external"> <area alt="" coords="700,198,913,246" href="http://developer.mozilla.org/en/nsDependentSubstring_external" shape="rect" title="nsDependentSubstring_external"> <area alt="" coords="937,198,1071,246" href="http://developer.mozilla.org/en/PromiseFlatString_(External)" shape="rect" title="PromiseFlatString_(External)"> <area alt="" coords="1095,198,1196,246" href="http://developer.mozilla.org/en/nsAutoString_(External)" shape="rect" title="nsAutoString_(External)"> <area alt="" coords="5,294,197,342" href="http://developer.mozilla.org/en/nsDependentString_external" shape="rect" title="nsDependentString_external"> <area alt="" coords="221,294,467,342" href="http://developer.mozilla.org/en/NS_ConvertASCIItoUTF16_external" shape="rect" title="NS_ConvertASCIItoUTF16_external"> <area alt="" coords="491,294,733,342" href="http://developer.mozilla.org/en/NS_ConvertUTF8toUTF16_external" shape="rect" title="NS_ConvertUTF8toUTF16_external"> <area alt="" coords="757,294,869,342" href="http://developer.mozilla.org/en/nsLiteralString_(External)" shape="rect" title="nsLiteralString_(External)"> </map>

Method Overview

BeginReading
EndReading
CharAt
operator[]
First
BeginWriting
EndWriting
SetLength
Length
IsEmpty
SetIsVoid
IsVoid
Assign
AssignLiteral
operator=
Replace
Append
AppendLiteral
operator+=
Insert
Cut
Truncate
StripChars
StripWhitespace
Trim
DefaultComparator
Compare
Equals
operator<
operator<=
operator==
operator>=
operator>
operator!=
EqualsLiteral
LowerCaseEqualsLiteral
Find
RFind
FindChar
RFindChar
AppendInt
ToInteger

Data Members

No public members.

Methods

BeginReading

PRUint32 BeginReading(const PRUnichar**, const PRUnichar**) const - source
Returns the length, beginning, and end of a string in one operation.

Parameters

  • PRUnichar** begin
  • PRUnichar** end
PRUnichar* BeginReading() const - source

EndReading

PRUnichar* EndReading() const - source

CharAt

PRUnichar CharAt(PRUint32) const - source

Parameters

  • PRUint32 aPos

operator[]

PRUnichar operator[](PRUint32) const - source

Parameters

  • PRUint32 aPos

First

PRUnichar First() const - source

BeginWriting

PRUint32 BeginWriting(PRUnichar**, PRUnichar**, PRUint32) - source
Get the length, begin writing, and optionally set the length of a
string all in one operation.

@param   newSize Size the string to this length. Pass PR_UINT32_MAX
to leave the length unchanged.
@return  The new length of the string, or 0 if resizing failed.

Parameters

  • PRUnichar** begin
  • PRUnichar** end
  • PRUint32 newSize
PRUnichar* BeginWriting(PRUint32) - source

Parameters

  • PRUint32 <anonymous>

EndWriting

PRUnichar* EndWriting() - source

SetLength

PRBool SetLength(PRUint32) - source

Parameters

  • PRUint32 aLen

Length

PRUint32 Length() const - source

IsEmpty

PRBool IsEmpty() const - source

SetIsVoid

void SetIsVoid(PRBool) - source

Parameters

  • PRBool val

IsVoid

PRBool IsVoid() const - source

Assign

void Assign(const nsAString&) - source

Parameters

  • nsAString& aString
void Assign(const PRUnichar*, PRUint32) - source

Parameters

  • PRUnichar* aData
  • PRUint32 aLength
void Assign(PRUnichar) - source

Parameters

  • PRUnichar aChar

AssignLiteral

void AssignLiteral(const char*) - source

Parameters

  • char* aStr

operator=

nsAString& operator=(const nsAString&) - source

Parameters

  • nsAString& aString
nsAString& operator=(const PRUnichar*) - source

Parameters

  • PRUnichar* aPtr
nsAString& operator=(PRUnichar) - source

Parameters

  • PRUnichar aChar

Replace

void Replace(PRUint32, PRUint32, const PRUnichar*, PRUint32) - source

Parameters

  • PRUint32 cutStart
  • PRUint32 cutLength
  • PRUnichar* data
  • PRUint32 length
void Replace(PRUint32, PRUint32, PRUnichar) - source

Parameters

  • PRUint32 cutStart
  • PRUint32 cutLength
  • PRUnichar c
void Replace(PRUint32, PRUint32, const nsAString&) - source

Parameters

  • PRUint32 cutStart
  • PRUint32 cutLength
  • nsAString& readable

Append

void Append(PRUnichar) - source

Parameters

  • PRUnichar c
void Append(const PRUnichar*, PRUint32) - source

Parameters

  • PRUnichar* data
  • PRUint32 length
void Append(const nsAString&) - source

Parameters

  • nsAString& readable

AppendLiteral

void AppendLiteral(const char*) - source

Parameters

  • char* aASCIIStr

operator+=

nsAString& operator+=(PRUnichar) - source

Parameters

  • PRUnichar c
nsAString& operator+=(const PRUnichar*) - source

Parameters

  • PRUnichar* data
nsAString& operator+=(const nsAString&) - source

Parameters

  • nsAString& readable

Insert

void Insert(PRUnichar, PRUint32) - source

Parameters

  • PRUnichar c
  • PRUint32 pos
void Insert(const PRUnichar*, PRUint32, PRUint32) - source

Parameters

  • PRUnichar* data
  • PRUint32 pos
  • PRUint32 length
void Insert(const nsAString&, PRUint32) - source

Parameters

  • nsAString& readable
  • PRUint32 pos

Cut

void Cut(PRUint32, PRUint32) - source

Parameters

  • PRUint32 cutStart
  • PRUint32 cutLength

Truncate

void Truncate() - source

StripChars

void StripChars(const char*) - source
Remove all occurences of characters in aSet from the string.

Parameters

  • char* aSet

StripWhitespace

void StripWhitespace() - source
Strip whitespace characters from the string.

Trim

void Trim(const char*, PRBool, PRBool) - source

Parameters

  • char* aSet
  • PRBool aLeading
  • PRBool aTrailing

DefaultComparator

PRInt32 DefaultComparator(const PRUnichar*, const PRUnichar*, PRUint32) - source

Parameters

  • PRUnichar* a
  • PRUnichar* b
  • PRUint32 length

Compare

PRInt32 Compare(const PRUnichar*, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source

Parameters

  • PRUnichar* other
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c
PRInt32 Compare(const nsAString&, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source

Parameters

  • nsAString& other
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c

Equals

PRBool Equals(const PRUnichar*, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source

Parameters

  • PRUnichar* other
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c
PRBool Equals(const nsAString&, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source

Parameters

  • nsAString& other
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c

operator<

PRBool operator<(const nsAString&) const - source

Parameters

  • nsAString& other
PRBool operator<(const PRUnichar*) const - source

Parameters

  • PRUnichar* other

operator<=

PRBool operator<=(const nsAString&) const - source

Parameters

  • nsAString& other
PRBool operator<=(const PRUnichar*) const - source

Parameters

  • PRUnichar* other

operator==

PRBool operator==(const nsAString&) const - source

Parameters

  • nsAString& other
PRBool operator==(const PRUnichar*) const - source

Parameters

  • PRUnichar* other

operator>=

PRBool operator>=(const nsAString&) const - source

Parameters

  • nsAString& other
PRBool operator>=(const PRUnichar*) const - source

Parameters

  • PRUnichar* other

operator>

PRBool operator>(const nsAString&) const - source

Parameters

  • nsAString& other
PRBool operator>(const PRUnichar*) const - source

Parameters

  • PRUnichar* other

operator!=

PRBool operator!=(const nsAString&) const - source

Parameters

  • nsAString& other
PRBool operator!=(const PRUnichar*) const - source

Parameters

  • PRUnichar* other

EqualsLiteral

PRBool EqualsLiteral(const char*) const - source

Parameters

  • char* aASCIIString

LowerCaseEqualsLiteral

PRBool LowerCaseEqualsLiteral(const char*) const - source
Case-insensitive match this string to a lowercase ASCII string.

Parameters

  • char* aASCIIString

Find

PRInt32 Find(const nsAString&, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source
Find the first occurrence of aStr in this string.

@return the offset of aStr, or -1 if not found

Parameters

  • nsAString& aStr
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c
PRInt32 Find(const nsAString&, PRUint32, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source
Find the first occurrence of aStr in this string, beginning at aOffset.

@return the offset of aStr, or -1 if not found

Parameters

  • nsAString& aStr
  • PRUint32 aOffset
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c
PRInt32 Find(const char*, PRBool) const - source
Find an ASCII string within this string.

@return the offset of aStr, or -1 if not found.

Parameters

  • char* aStr
  • PRBool aIgnoreCase
PRInt32 Find(const char*, PRUint32, PRBool) const - source

Parameters

  • char* aStr
  • PRUint32 aOffset
  • PRBool aIgnoreCase

RFind

PRInt32 RFind(const nsAString&, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source
Find the last occurrence of aStr in this string.

@return The offset of aStr from the beginning of the string,
or -1 if not found.

Parameters

  • nsAString& aStr
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c
PRInt32 RFind(const nsAString&, PRInt32, PRInt32 (*)(const PRUnichar*, const PRUnichar*, PRUint32)) const - source
Find the last occurrence of aStr in this string, beginning at aOffset.

@param aOffset the offset from the beginning of the string to begin
searching. If aOffset < 0, search from end of this string.
@return The offset of aStr from the beginning of the string,
or -1 if not found.

Parameters

  • nsAString& aStr
  • PRInt32 aOffset
  • PRInt32 (*)(PRUnichar*, PRUnichar*, PRUint32) c
PRInt32 RFind(const char*, PRBool) const - source
Find the last occurrence of an ASCII string within this string.

@return The offset of aStr from the beginning of the string,
or -1 if not found.

Parameters

  • char* aStr
  • PRBool aIgnoreCase
PRInt32 RFind(const char*, PRInt32, PRBool) const - source
Find the last occurrence of an ASCII string beginning at aOffset.

@param aOffset the offset from the beginning of the string to begin
searching. If aOffset < 0, search from end of this string.
@return The offset of aStr from the beginning of the string,
or -1 if not found.

Parameters

  • char* aStr
  • PRInt32 aOffset
  • PRBool aIgnoreCase

FindChar

PRInt32 FindChar(PRUnichar, PRUint32) const - source
Search for the offset of the first occurrence of a character in a
string.

@param aOffset the offset from the beginning of the string to begin
searching
@return The offset of the character from the beginning of the string,
or -1 if not found.

Parameters

  • PRUnichar aChar
  • PRUint32 aOffset

RFindChar

PRInt32 RFindChar(PRUnichar) const - source
Search for the offset of the last occurrence of a character in a
string.

@return The offset of the character from the beginning of the string,
or -1 if not found.

Parameters

  • PRUnichar aChar

AppendInt

void AppendInt(int, PRInt32) - source
Append a string representation of a number.

Parameters

  • int aInt
  • PRInt32 aRadix

ToInteger

PRInt32 ToInteger(nsresult*, PRUint32) const - source
Convert this string to an integer.

@param aErrorCode pointer to contain result code.
@param aRadix must be 10 or 16

Parameters

  • nsresult* aErrorCode
  • PRUint32 aRadix