1. Epic GamesDeveloper
  3. String

String

Unreal Engine C++ API Reference > Runtime > Core

Classes

  Type Name Description
Public struct FEscape    
Public struct FQuoteEscape    
Public struct FResult    
Public struct TAtArgPos    
Public struct TCheckFormatString    
Public struct TFmtArgTypes    
Public struct TIsEnumAsByte Returns true only when the type is TEnumAsByte.  
Public struct TJoinBy    
Public struct TJoinQuotedBy    
Public struct TJoinTupleBy    
Public struct TJoinTupleQuotedBy    
Public struct TLowerCase    
Public struct TPresentErr    
Public struct TUpperCase    

Enums

  Type Name Description
Public enum UE::Core::Private::FormatStringSan::EFormatStringSanStatus    
Public enum UE::String::EParseLinesOptions    
Public enum UE::String::EParseTokensOptions    

Functions

  Type Name Description
Public function void

LexFromString ( float& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( uint32& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( uint16& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( uint8& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( int64& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( int32& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( int16& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( int8& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( double& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( bool& OutValue,
const FStringView& InString
)

  
Public function void

LexFromString ( uint64& OutValue,
const FStringView& InString
)

  
Public function TFmtArgTypes< Ts... >  
Public function Private::FEscape Escape the string when appended to a string builder.Example: Builder << String::Escape(Value);
Public function Private::TJoinBy< RangeType, FIdentityFunctor, DelimiterType >

UE::String::Join ( RangeType&& Range,
DelimiterType&& Delimiter
)

 Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter.
Public function Private::TJoinBy< RangeType, ProjectionType, DelimiterType >

UE::String::JoinBy ( RangeType&& Range,
ProjectionType Projection,
DelimiterType&& Delimiter
)

 Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter.
Public function TStringBuilderBase< CharType > &

UE::String::JoinByTo ( RangeType&& Range,
ProjectionType Projection,
DelimiterType&& Delimiter,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the range to the builder, separating the elements by the delimiter.
Public function Private::TJoinQuotedBy< RangeType, FIdentityFunctor, DelimiterType, QuoteType >

UE::String::JoinQuoted ( RangeType&& Range,
DelimiterType&& Delimiter,
QuoteType&& Quote
)

 Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.
Public function Private::TJoinQuotedBy< RangeType, ProjectionType, DelimiterType, QuoteType >

UE::String::JoinQuotedBy ( RangeType&& Range,
ProjectionType Projection,
DelimiterType&& Delimiter,
QuoteType&& Quote
)

 Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.
Public function TStringBuilderBase< CharType > &

UE::String::JoinQuotedByTo ( RangeType&& Range,
ProjectionType Projection,
DelimiterType&& Delimiter,
QuoteType&& Quote,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the range to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.
Public function TStringBuilderBase< CharType > &

UE::String::JoinQuotedTo ( RangeType&& Range,
DelimiterType&& Delimiter,
QuoteType&& Quote,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the range to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.
Public function TStringBuilderBase< CharType > &

UE::String::JoinTo ( RangeType&& Range,
DelimiterType&& Delimiter,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the range to the builder, separating the elements by the delimiter.
Public function Private::TJoinTupleBy< TupleType, FIdentityFunctor, DelimiterType >

UE::String::JoinTuple ( TupleType&& Tuple,
DelimiterType&& Delimiter
)

 Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter.
Public function Private::TJoinTupleBy< TupleType, ProjectionType, DelimiterType >

UE::String::JoinTupleBy ( TupleType&& Tuple,
ProjectionType Projection,
DelimiterType&& Delimiter
)

 Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter.
Public function TStringBuilderBase< CharType > &

UE::String::JoinTupleByTo ( TupleType&& Tuple,
ProjectionType Projection,
DelimiterType&& Delimiter,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the tuple to the builder, separating the elements by the delimiter.
Public function Private::TJoinTupleQuotedBy< TupleType, FIdentityFunctor, DelimiterType, QuoteType >

UE::String::JoinTupleQuoted ( TupleType&& Tuple,
DelimiterType&& Delimiter,
QuoteType&& Quote
)

 Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.
Public function Private::TJoinTupleQuotedBy< TupleType, ProjectionType, DelimiterType, QuoteType >

UE::String::JoinTupleQuotedBy ( TupleType&& Tuple,
ProjectionType Projection,
DelimiterType&& Delimiter,
QuoteType&& Quote
)

 Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.
Public function TStringBuilderBase< CharType > &

UE::String::JoinTupleQuotedByTo ( TupleType&& Tuple,
ProjectionType Projection,
DelimiterType&& Delimiter,
QuoteType&& Quote,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the tuple to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.
Public function TStringBuilderBase< CharType > &

UE::String::JoinTupleQuotedTo ( TupleType&& Tuple,
DelimiterType&& Delimiter,
QuoteType&& Quote,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the tuple to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.
Public function TStringBuilderBase< CharType > &

UE::String::JoinTupleTo ( TupleType&& Tuple,
DelimiterType&& Delimiter,
TStringBuilderBase< CharType >& Builder
)

 Append every element of the tuple to the builder, separating the elements by the delimiter.
Public function Private::TLowerCase< WIDECHAR >  
Public function Private::TLowerCase< UTF8CHAR >  
Public function Private::TLowerCase< ANSICHAR > Convert the string to lowercase when appended to a string builder.
Public function bool  
Public function bool  
Public function EParseLinesOptions  
Public function EParseTokensOptions  
Public function EParseLinesOptions &  
Public function EParseTokensOptions &  
Public function EParseLinesOptions  
Public function EParseTokensOptions  
Public function EParseTokensOptions &  
Public function EParseLinesOptions &  
Public function EParseLinesOptions  
Public function EParseTokensOptions  
Public function EParseLinesOptions &  
Public function EParseTokensOptions &  
Public function EParseLinesOptions  
Public function EParseTokensOptions  
Public function void

UE::String::ParseLines ( const FStringView View,
OutputType& Output,
const EParseLinesOptions Options
)

 Parse lines in the input string as terminated by any of CRLF, CR, LF.
Public function void

UE::String::ParseTokens ( const FAnsiStringView View,
const ANSICHAR Delimiter,
OutputType& Output,
const EParseTokensOptions Options
)

 Parses every token in the input string, as separated by the delimiter.
Public function void

UE::String::ParseTokens ( const FWideStringView View,
const WIDECHAR Delimiter,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokens ( const FUtf8StringView View,
const UTF8CHAR Delimiter,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokens ( const FAnsiStringView View,
const FAnsiStringView Delimiter,
OutputType& Output,
const EParseTokensOptions Options
)

 Parses every token in the input string, as separated by the delimiter.
Public function void

UE::String::ParseTokens ( const FWideStringView View,
const FWideStringView Delimiter,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokens ( const FUtf8StringView View,
const FUtf8StringView Delimiter,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokensMultiple ( const FUtf8StringView View,
const TConstArrayView< UTF8CHAR > Delimiters,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokensMultiple ( const FUtf8StringView View,
const TConstArrayView< FUtf8StringView > Delimiters,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokensMultiple ( const FWideStringView View,
const TConstArrayView< FWideStringView > Delimiters,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokensMultiple ( const FAnsiStringView View,
const TConstArrayView< ANSICHAR > Delimiters,
OutputType& Output,
const EParseTokensOptions Options
)

 Parses every token in the input string, as separated by any of the delimiters.
Public function void

UE::String::ParseTokensMultiple ( const FWideStringView View,
const TConstArrayView< WIDECHAR > Delimiters,
OutputType& Output,
const EParseTokensOptions Options
)

  
Public function void

UE::String::ParseTokensMultiple ( const FAnsiStringView View,
const TConstArrayView< FAnsiStringView > Delimiters,
OutputType& Output,
const EParseTokensOptions Options
)

 Parses every token in the input string, as separated by any of the delimiters.
Public function Private::FQuoteEscape Quote and escape the string when appended to a string builder.
Public function TStringView< CharType >

UE::String::RemoveFromEnd ( const TStringView< CharType > View,
const TStringView< CharType > Prefix,
ESearchCase::Type SearchCase
)

  
Public function TStringView< CharType >

UE::String::RemoveFromStart ( const TStringView< CharType > View,
const TStringView< CharType > Prefix,
ESearchCase::Type SearchCase
)

  
Public function Private::TUpperCase< UTF8CHAR >  
Public function Private::TUpperCase< ANSICHAR > Convert the string to uppercase when appended to a string builder.
Public function Private::TUpperCase< WIDECHAR >  

Variables

  Type Name Description
Public variable bool bFmtStrErr  
Public variable bool bIsAConstString Returns true when the type is a const char*, const TCHAR*, const char[] or const TCHAR[].
Public variable bool bIsCharPtr  
Public variable bool bIsFloatOrDouble  
Public variable bool bIsIntegralEnum  
Public variable bool bIsPointerTo  
Public variable bool bIsTCharPtr  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page