CString Class Members

  • Article

Construction
The String as an Array
Assignment/Concatenation
Comparison
Extraction
Other Conversions
Searching
Archive/Dump
Buffer Access
Windows-Specific

Construction

CString Constructs CString objects in various ways.

The String as an Array

GetLength Returns the number of characters in a CString object. For multibyte characters, counts each 8-bit character; that is, a lead and trail byte in one multibyte character are counted as two characters.
IsEmpty Tests whether a CString object contains no characters.
Empty Forces a string to have 0 length.
GetAt Returns the character at a given position.
operator [] Returns the character at a given position — operator substitution for GetAt.
SetAt Sets a character at a given position.
operator LPCTSTR Directly accesses characters stored in a CString object as a C-style string.

Assignment/Concatenation

operator = Assigns a new value to a CString object.
operator + Concatenates two strings and returns a new string.
operator += Concatenates a new string to the end of an existing string.

Comparison

operator == <, etc. Comparison operators (case sensitive).
Compare Compares two strings (case sensitive).
CompareNoCase Compares two strings (case insensitive).
Collate Compares two strings (case sensitive, uses locale-specific information).
CollateNoCase Compares two strings (case insensitive, uses locale-specific information).

Extraction

Mid Extracts the middle part of a string (like the Basic MID$ function).
Left Extracts the left part of a string (like the Basic LEFT$ function).
Right Extracts the right part of a string (like the Basic RIGHT$ function).
SpanIncluding Extracts a substring that contains only the characters in a set.
SpanExcluding Extracts a substring that contains only the characters not in a set.

Other Conversions

MakeUpper Converts all the characters in this string to uppercase characters.
MakeLower Converts all the characters in this string to lowercase characters.
MakeReverse Reverses the characters in this string.
Replace Replaces indicated characters with other characters.
Remove Removes indicated characters from a string.
Insert Inserts a single character or a substring at the given index within the string.
Delete Deletes a character or characters from a string.
Format Format the string as sprintf does.
FormatV Formats the string as vsprintf does.
TrimLeft Trim leading whitespace characters from the string.
TrimRight Trim trailing whitespace characters from the string.
FormatMessage Formats a message string.

Searching

Find Finds a character or substring inside a larger string.
ReverseFind Finds a character inside a larger string; starts from the end.
FindOneOf Finds the first matching character from a set.

Archive/Dump

operator << Inserts a CString object to an archive or dump context.
operator >> Extracts a CString object from an archive.

Buffer Access

GetBuffer Returns a pointer to the characters in the CString.
GetBufferSetLength Returns a pointer to the characters in the CString, truncating to the specified length.
ReleaseBuffer Releases control of the buffer returned by GetBuffer.
FreeExtra Removes any overhead of this string object by freeing any extra memory previously allocated to the string.
LockBuffer Disables reference counting and protects the string in the buffer.
UnlockBuffer Enables reference counting and releases the string in the buffer.

Windows-Specific

AllocSysString Allocates a BSTR from CString data.
SetSysString Sets an existing BSTR object with data from a CString object.
LoadString Loads an existing CString object from a Windows resource.
AnsiToOem Makes an in-place conversion from the ANSI character set to the OEM character set.
OemToAnsi Makes an in-place conversion from the OEM character set to the ANSI character set.

CString Overview |  Hierarchy Chart