NS_StringGetData

« XPCOM API Reference

Summary

The NS_StringGetData function gives the caller access to the string's internal buffer. This is a low-level API.

  #include "nsStringAPI.h"
  PRUint32 NS_StringGetData(
    const nsAString& aString,
    const PRUnichar** aData,
    PRBool* aTerminated
  );

Parameters

aString

[in] A nsAString instance to inspect.

aData

[out] A const pointer to the string's internal buffer.

aTerminated

[out] This optional result parameter indicates whether or not aData is null-terminated.

Return Values

The NS_StringGetData function returns the length of aData, measured in storage units (bytes).

Example Code

  PRUint32 CountChar(const nsAString& str, PRUnichar c)
  {
    const PRUnichar* data;
    PRUint32 len = NS_StringGetData(str, &data);
    PRUint32 count = 0;
    for (PRUint32 i = 0; i < len; ++i)
    {
      if (data[i] == c)
        ++count;
    }
    return count;
  }

History

This function was frozen for Mozilla 1.7. See bug 239123 for details.

See Also

nsAString