NS_CStringSetData

« XPCOM API Reference

Summary

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

#include "nsStringAPI.h"
 
nsresult NS_CStringSetData(
  nsACString& aString,
  const char* aData,
  PRUint32 aDataLength = PR_UINT32_MAX
);

Parameters

aString

[in] A nsACString 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_CStringSetData function returns NS_OK if successful. Otherwise, it returns an error code.

Example

nsCStringContainer str;
rv = NS_CStringContainerInit(str);
if (NS_SUCCEEDED(rv))
{
  rv = NS_CStringSetData(str, "hello world");
  if (NS_SUCCEEDED(rv))
  {
    // now, pass |str| to some function expecting a |const nsACString&| parameter.
  }
  NS_CStringContainerFinish(str);
}

History

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

See Also

nsACString