NS CStringAppendData

From MDC

« XPCOM API Reference

Contents 1 Summary 2 Parameters 3 Return Values 4 Remarks 5 Example 6 History 7 See Also

[edit] 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
);

[edit] 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.

[edit] Return Values

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

[edit] Remarks

This function is defined inline as a wrapper around NS_CStringSetDataRange.

[edit] 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);

[edit] History

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

[edit] See Also

NS_CStringSetDataRange, nsACString