Summary
The NS_StringInsertData
function appends data to the existing value of a nsACString
instance. This is a low-level API.
#include "nsStringAPI.h" nsresult NS_StringInsertData( nsACString& aString, PRUint32 aOffset, const PRUnichar* aData, PRUint32 aDataLength = PR_UINT32_MAX );
Parameters
- aString
- [in] A
nsACString
instance to be modified. - aOffset
- [in] An offset into the string's internal buffer specifying where to place the given characters.
- 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_StringInsertData
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"); NS_StringInsertData(str, 5, L" world"); const PRUnichar* data; NS_StringGetData(str, &data); // data now points to the string: L"hello world" NS_StringContainerFinish(str);
History
This function was frozen for Mozilla 1.7. See bug 239123 for details.