MDN may have intermittent access issues April 18 13:00 - April 19 01:00 UTC. See whistlepig.mozilla.org for all notifications.

mozilla
Your Search Results

    NS_StringSetData

    « XPCOM API Reference

    Summary

    The NS_StringSetData function copies data into the string's internal buffer. This is a low-level API.

      #include "nsStringAPI.h"
    
      nsresult NS_StringSetData(
        nsAString& aString,
        const PRUnichar* aData,
        PRUint32 aDataLength = PR_UINT32_MAX
      );
    

    Parameters

    aString
    [in] A nsAString instance to modify.
    aData
    [in] A raw character array to copy into this string.
    aDataLength
    [in] The length of aData, measured in storage units. If equal to PR_UINT32_MAX, then aData is assumed to be null-terminated. Otherwise, aData need not be null terminated.

    Return Values

    The NS_StringSetData function returns NS_OK if successful. Otherwise, it returns an error code.

    Example Code

      nsStringContainer str;
      rv = NS_StringContainerInit(str);
      if (NS_SUCCEEDED(rv))
      {
        rv = NS_StringSetData(str, "hello world");
        if (NS_SUCCEEDED(rv))
        {
          // now, pass |str| to some function expecting a |const nsAString&| parameter.
        }
        NS_StringContainerFinish(str);
      }
    

    History

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

    See Also

    nsAString

    Document Tags and Contributors

    Contributors to this page: Pmash, Sheppy
    Last updated by: Sheppy,