Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FGenericPlatformString

Generic string implementation for most platforms

Windows

MacOS

Linux

Inheritance Hierarchy

FGenericPlatformStricmp

FGenericPlatformString

FGenericWidePlatformString

FMicrosoftPlatformString

FHoloLensString

FStandardPlatformString

FUnixPlatformString

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformString.h
Include	#include "GenericPlatform/GenericPlatformString.h"

Syntax

struct FGenericPlatformString : public FGenericPlatformStricmp

Remarks

Generic string implementation for most platforms

Functions

	Name	Description
bool	CanConvertChar ( SourceEncoding Ch )	Tests whether a particular character can be converted to the destination encoding.
TEnableIf< T...	Convert ( DestEncoding* Dest, int32 DestSize, const SourceEncoding* Src, int32 SrcSize, DestEncoding BogusChar )	Converts the [Src, Src+SrcSize) string range from SourceChar to DestChar and writes it to the [Dest, Dest+DestSize) range.
TEnableIf< &...	Convert ( DestEncoding* Dest, int32 DestSize, const SourceEncoding* Src, int32 SrcSize, DestEncoding BogusChar )	Converts the [Src, Src+SrcSize) string range from SourceEncoding to DestEncoding and writes it to the [Dest, Dest+DestSize) range.
TEnableIf< T...	ConvertedLength ( const SourceEncoding* Src, int32 SrcSize )	Returns the required buffer length for the [Src, Src+SrcSize) string when converted to the DestChar encoding.
const ANSICH...	GetEncodingName()
const TCHAR ...	GetEncodingTypeName()	Returns the string representing the name of the given encoding type.
const TCHAR ...	GetEncodingTypeName()
const TCHAR ...	GetEncodingTypeName()
const TCHAR ...	GetEncodingTypeName()
bool	IsValidChar ( Encoding Ch )	Tests whether a particular character is a valid member of its encoding.
bool	IsValidChar ( ANSICHAR Ch )	Specialization of IsValidChar for ANSICHARs.

Classes

	Name	Description
	TAreEncodingsCompatible	Metafunction which tests whether two encodings are compatible.
	TIsFixedWidthEncoding
	TIsFixedWidthEncoding_Helper	Metafunction which tests whether a given character type represents a fixed-width encoding.
	TIsFixedWidthEncoding_Helper< Dummy, ANSICHAR >
	TIsFixedWidthEncoding_Helper< Dummy, UCS2CHAR >
	TIsFixedWidthEncoding_Helper< Dummy, WIDECHAR >

Constants

Name	Description
IsUnicodeEncoded	True if the encoding type of the string is some form of unicode

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss