NS_CStringCutData

« XPCOM API Reference

Summary

The NS_CStringCutData function removes a section of the string's internal buffer. This is a low-level API.

  #include "nsStringAPI.h"

  nsresult NS_CStringCutData(
    nsACString& aString,
    PRUint32 aCutStart,
    PRUint32 aCutLength
  );

Parameters

aString

[in] A nsACString instance to be modified.

aCutStart

[in] The starting index of the section to remove, measured in storage units.

aCutLength

[in] The length of the section to remove, measured in storage units. Pass PR_UINT32_MAX to specify the length from aCutStart to the end of the string.

Return Values

The NS_CStringCutData 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 Code

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

  // remove " world" portion of string
  NS_CStringCutData(str, 5, PR_UINT32_MAX);

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

  NS_CStringContainerFinish(str);

History

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

See Also

NS_CStringSetDataRange , nsACString