NS_StringCutData

Summary

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

  #include "nsStringAPI.h"

  nsresult NS_StringCutData(
    nsAString& aString,
    PRUint32 aCutStart,
    PRUint32 aCutLength
  );

Parameters

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

Remarks

This function is defined inline as a wrapper around NS_StringSetDataRange.

Note: GCC requires the -fshort-wchar option to compile this example since PRUnichar is an unsigned short. This example should compile by default under MSVC.

Example Code

  nsStringContainer str;
  NS_StringContainerInit(str);
  NS_StringSetData(str, L"hello world");

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

  const PRUnichar* data;
  NS_StringGetData(str, &data);
  // data now ponts to the string: L"hello"

  NS_StringContainerFinish(str);

History

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