NS CStringCopy

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_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
);

[edit] Parameters

aDestString

[in] A nsACString instance to be modified.

aSrcString

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

[edit] Return Values

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

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

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

[edit] History

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

[edit] See Also

nsACString