1. Epic GamesDeveloper
  3. TCString

TCString

Set of basic string utility functions operating on plain C strings.

API > API/Runtime > API/Runtime/Core

Set of basic string utility functions operating on plain C strings. In addition to the wrapped C string API,this struct also contains a set of widely used utility functions that operate on c strings. There is a specialized implementation for ANSICHAR and WIDECHAR strings provided. To access these functionality, the convenience typedefs FCString and FCStringAnsi are provided.

   
Name TCString
Type struct
Header File /Engine/Source/Runtime/Core/Public/Misc/CString.h
Include Path #include "Misc/CString.h"

Syntax

template<typename T>  
struct TCString

Typedefs

Name Type Remarks Include Path
CharType T   Misc/CString.h
TIsCharEncodingCompatibleWithCharType TIsCharEncodingCompatibleWith< SrcEncoding, CharType >   Misc/CString.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static double Atod ( const CharType* String
)

 Atod wrapper Misc/CString.h  

static float Atof ( const CharType* String
)

 Atof wrapper Misc/CString.h  

static int32 Atoi ( const CharType* String
)

 Atoi wrapper Misc/CString.h  

static int64 Atoi64 ( const CharType* String
)

 Atoi64 wrapper Misc/CString.h  

static int32 GetVarArgs ( CharType* Dest,
SIZE_T DestSize,
const CharType*& Fmt,
va_list ArgPtr
)

 Helper function to write formatted output using an argument list Misc/CString.h  

static bool IsNumeric ( const CharType* Str
)

 Returns whether this string contains only numeric characters Misc/CString.h  

static bool IsPureAnsi ( const CharType* Str
)

 Returns whether this string contains only pure ansi characters Misc/CString.h  

static bool IsPureAnsi ( const CharType* Str,
const SIZE_T StrLen
)

   Misc/CString.h  

static int32 Snprintf ( CharType* Dest,
int32 DestSize,
const FmtType& Fmt,
Types... Args
)

 Safe string formatted print. Misc/CString.h  

static int32 SnprintfImpl ( CharType* Dest,
int32 DestSize,
const CharType* Fmt,
...
)

   Misc/CString.h  

static const CharType * Spc ( int32 NumSpaces
)

 Returns a static string that is filled with a variable number of spaces Misc/CString.h  

static int32 Sprintf ( CharType* Dest,
const FmtType& Fmt,
Types... Args
)

 Standard string formatted print. Misc/CString.h  

static int32 SprintfImpl ( CharType* Dest,
const CharType* Fmt,
...
)

   Misc/CString.h  

static CharType * Strcat ( CharType(&) Dest,
const CharType* Src
)

 Strcat wrapper (templated version to automatically handle static destination array case) Misc/CString.h  

static CharType * Strcat ( CharType* Dest,
const CharType* Src
)

 Strcat wrapper Misc/CString.h  

static CharType * Strcat ( CharType* Dest,
SIZE_T DestSize,
const CharType* Src
)

 This version was deprecated because Strcat taking a size field does not match the CRT strcat, and on some platforms the size field was being ignored. Misc/CString.h  

static CharType * Strchr ( CharType* String,
CharType c
)

   Misc/CString.h  

static const CharType * Strchr ( const CharType* String,
CharType c
)

 Strchr wrapper Misc/CString.h  

static int32 Strcmp ( const CharType* String1,
const CharType* String2
)

 Strcmp wrapper Misc/CString.h  

static CharType * Strcpy ( CharType* Dest,
const CharType* Src
)

 Strcpy wrapper Misc/CString.h  

static CharType * Strcpy ( CharType(&) Dest,
const CharType* Src
)

 Strcpy wrapper (templated version to automatically handle static destination array case) Misc/CString.h  

static CharType * Strcpy ( CharType* Dest,
SIZE_T DestCount,
const CharType* Src
)

 This version was deprecated because Strcpy taking a size field does not match the CRT strcpy, and on some platforms the size field was being ignored. Misc/CString.h  

static int32 Strcspn ( const CharType* String,
const CharType* Mask
)

 Strcspn wrapper Misc/CString.h  

static const CharType * Strfind ( const CharType* Str,
const CharType* Find,
bool bSkipQuotedChars
)

 Find string in string, case sensitive, requires non-alphanumeric lead-in. Misc/CString.h  

static const CharType * StrfindDelim ( const CharType* Str,
const CharType* Find,
const CharType* Delim
)

 Finds string in string, case insensitive, requires the string be surrounded by one the specified delimiters, or the start or end of the string. Misc/CString.h  

static int32 Stricmp ( const CharType* String1,
const CharType* String2
)

 Stricmp wrapper Misc/CString.h  

static const CharType * Strifind ( const CharType* Str,
const CharType* Find,
bool bSkipQuotedChars
)

 Find string in string, case insensitive, requires non-alphanumeric lead-in. Misc/CString.h  

static const CharType * Stristr ( const CharType* Str,
const CharType* Find
)

 Finds string in string, case insensitive Finds string in string, case insensitive Misc/CString.h  

static CharType * Stristr ( CharType* Str,
const CharType* Find
)

 Finds string in string, case insensitive (non-const version) Misc/CString.h  

static int32 Strlen ( const CharType* String
)

 Strlen wrapper Misc/CString.h  

static CharType * Strncat ( CharType* Dest,
const CharType* Src,
int32 DestSize
)

 This version was deprecated because it had a different interpretation of the length argument than CRT strncat. Misc/CString.h  

static CharType * StrncatTruncateDest ( CharType* Dest,
int32 DestSize,
const CharType* Src
)

 Concatenate a string with length checking. Misc/CString.h  

static CharType * StrncatTruncateSrc ( CharType* Dest,
const CharType* Src,
int32 SrcLen
)

 Append at most SrcLen characters from Src to Dest. Misc/CString.h  

static int32 Strncmp ( const CharType* String1,
const CharType* String2,
SIZE_T Count
)

 Strncmp wrapper Misc/CString.h  

static CharType * Strncpy ( CharType* Dest,
const CharType* Src,
SIZE_T MaxLen
)

 Copy a string with length checking. Behavior differs from strncpy in that last character is zeroed. Misc/CString.h  

static int32 Strnicmp ( const CharType* String1,
const CharType* String2,
SIZE_T Count
)

 Strnicmp wrapper Misc/CString.h  

static const CharType * Strnistr ( const CharType* Str,
int32 InStrLen,
const CharType* Find,
int32 FindLen
)

 Finds string in string, case insensitive Misc/CString.h  

static CharType * Strnistr ( CharType* Str,
int32 InStrLen,
const CharType* Find,
int32 FindLen
)

 Finds string in string, case insensitive (non-const version) Misc/CString.h  

static int32 Strnlen ( const CharType* String,
SIZE_T StringSize
)

 Calculate the length of the string up to the given size. Misc/CString.h  

static CharType * Strnstr ( CharType* Str,
int32 InStrLen,
const CharType* Find,
int32 FindLen
)

 Finds string in string, case sensitive (non-const version) Misc/CString.h  

static const CharType * Strnstr ( const CharType* Str,
int32 InStrLen,
const CharType* Find,
int32 FindLen
)

 Finds string in string, case sensitive Misc/CString.h  

static CharType * Strrchr ( CharType* String,
CharType c
)

   Misc/CString.h  

static const CharType * Strrchr ( const CharType* String,
CharType c
)

 Strrchr wrapper Misc/CString.h  

static const CharType * Strrstr ( const CharType* String,
const CharType* Find
)

 Strrstr wrapper Misc/CString.h  

static CharType * Strrstr ( CharType* String,
const CharType* Find
)

   Misc/CString.h  

static int32 Strspn ( const CharType* String,
const CharType* Mask
)

 Strspn wrapper Misc/CString.h  

static const CharType * Strstr ( const CharType* String,
const CharType* Find
)

 Strstr wrapper Misc/CString.h  

static CharType * Strstr ( CharType* String,
const CharType* Find
)

   Misc/CString.h  

static int32 Strtoi ( const CharType* Start,
CharType** End,
int32 Base
)

 Strtoi wrapper Misc/CString.h  

static int64 Strtoi64 ( const CharType* Start,
CharType** End,
int32 Base
)

 Strtoi wrapper Misc/CString.h  

static CharType * Strtok ( CharType* TokenString,
const CharType* Delim,
CharType** Context
)

 Strtok wrapper Misc/CString.h  

static uint64 Strtoui64 ( const CharType* Start,
CharType** End,
int32 Base
)

 Strtoui wrapper Misc/CString.h  

static CharType * Strupr ( CharType(&) Dest
)

 Strupr wrapper (templated version to automatically handle static destination array case) Misc/CString.h  

static CharType * Strupr ( CharType* Dest,
SIZE_T DestCount
)

 Strupr wrapper Misc/CString.h  

static const CharType * Tab ( int32 NumTabs
)

 Returns a static string that is filled with a variable number of tabs Misc/CString.h  

static bool ToBool ( const CharType* String
)

 Converts a string into a boolean value 1, "True", "Yes", FCoreTexts::True, FCoreTexts::Yes, and non-zero integers become true 0, "False", "No", FCoreTexts::False, FCoreTexts::No, and unparsable values become false Misc/CString.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page