« XPCOM API Reference

Summary

The NS_CStringCopy function copies the value from one nsACString instance to another. This is a low-level API.

#include "nsStringAPI.h"

nsresult NS_CStringCopy(
  nsACString& aDestString,
  const nsACString& aSrcString
);

Parameters

aDestString

[in] A nsACString instance to be modified.

aSrcString

[in] A nsACString instance containing the new string value.

Return Values

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

Remarks

This function is designed to allow the implementation to efficiently assign the same value to two string objects. The implementation may employ reference counting techniques to optimize this operation.

Example

/* attribute ACString value; */
NS_IMETHODIMP MyComponent::GetValue(nsACString& aValue)
{
  return NS_CStringCopy(aValue, mValue);
}
NS_IMETHODIMP MyComponent::SetValue(const nsACString& aValue)
{
  return NS_CStringCopy(mValue, aValue);
}

History

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

See Also

nsACString