Share via


CSimpleStringT::SetString

Sets the string of a CSimpleStringT object.

void SetString( 
   PCXSTR pszSrc, 
   int nLength 
); 
void SetString( 
   PCXSTR pszSrc 
);

Parameters

  • pszSrc
    A pointer to a null-terminated string.

  • nLength
    A count of the number of characters in pszSrc.

Remarks

Copy a string into the CSimpleStringT object. SetString overwrites the older string data in the buffer.

Both versions of SetString check whether pszSrc is a null pointer, and if it is, throw an E_INVALIDARG error.

The one-parameter version of SetString expects pszSrc to point to a null-terminated string.

The two-parameter version of SetString also expects pszSrc to be a null-terminated string. It uses nLength as the string length unless it encounters a null terminator first.

The two-parameter version of SetString also checks whether pszSrc points to a location in the current buffer in CSimpleStringT. In this special case, SetString uses a memory copy function that does not overwrite the string data as it copies the string data back to its buffer.

Example

The following example demonstrates how to use CSimpleStringT::SetString.

CSimpleString s(_T("abcdef"), pMgr);
ASSERT(_tcscmp(s, _T("abcdef")) == 0);

s.SetString(_T("Soccer"), 6);
ASSERT(_tcscmp(s, _T("Soccer")) == 0);   

Requirements

Header: atlsimpstr.h

See Also

Reference

CSimpleStringT Class

Other Resources

CSimpleStringT Members

Change History

Date

History

Reason

October 2009

Described how different versions of SetString work.

Customer feedback.