NS_CStringAppendData

« XPCOM API Reference

Summary

The NS_CStringAppendData function appends data to the existing value of a nsACString instance. This is a low-level API.

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

Parameters

aString
[in] A nsACString instance to be modified.
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_CStringAppendData function returns NS_OK if successful. Otherwise, it returns an error code.

Remarks

This function is defined inline as a wrapper around NS_CStringSetDataRange.

Example

nsCStringContainer str;
NS_CStringContainerInit(str);
NS_CStringSetData(str, "hello");
 
NS_CStringAppendData(str, " world");

const char* data;
NS_CStringGetData(str, &data);
printf("%s\n", data); // prints out "hello world"

NS_CStringContainerFinish(str);

History

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

See Also

NS_CStringSetDataRange, nsACString

Document Tags and Contributors

 Contributors to this page: Sheppy, DarinFisher, Nickolay, Dria
 Last updated by: Sheppy,