UE::Core::Private::FTCHARToUTF8_Convert Class Reference

#include <StringConv.h>

Public Types
typedef TCHAR	FromType
typedef ANSICHAR	ToType

Static Public Member Functions
template<typename BufferType >
static int32	Utf8FromCodepoint (uint32 Codepoint, BufferType OutputIterator, uint32 OutputIteratorByteSizeRemaining)
template<typename SrcBufferType >
static int32	Convert (IntendedToType *Dest, int32 DestLen, const SrcBufferType *Source, int32 SourceLen)
template<typename SrcBufferType >
static UE_FORCEINLINE_HINT int32	Convert (ToType *Dest, int32 DestLen, const SrcBufferType *Source, int32 SourceLen)
template<typename SrcBufferType >
static UE_FORCEINLINE_HINT int32	ConvertedLength (const SrcBufferType *Source, int32 SourceLen)

Member Typedef Documentation

FromType

typedef TCHAR UE::Core::Private::FTCHARToUTF8_Convert::FromType

ToType

typedef ANSICHAR UE::Core::Private::FTCHARToUTF8_Convert::ToType

Member Function Documentation

Convert() [1/2]

template<typename SrcBufferType >

static int32 UE::Core::Private::FTCHARToUTF8_Convert::Convert ( IntendedToType *  Dest, int32  DestLen, const SrcBufferType *  Source, int32  SourceLen  )

inlinestatic

Converts a Source string into UTF8 and stores it in Dest.

Parameters

Dest	The destination output iterator. Usually ANSICHAR*, but you can supply your own output iterator. One can determine the number of characters written by checking the offset of Dest when the function returns.
DestLen	The length of the destination buffer.
Source	The source string to convert.
SourceLen	The length of the source string.

Returns

The number of bytes written to Dest, up to DestLen, or -1 if the entire Source string could did not fit in DestLen bytes.

Convert() [2/2]

template<typename SrcBufferType >

static UE_FORCEINLINE_HINT int32 UE::Core::Private::FTCHARToUTF8_Convert::Convert ( ToType *  Dest, int32  DestLen, const SrcBufferType *  Source, int32  SourceLen  )

inlinestatic

ConvertedLength()

template<typename SrcBufferType >

static UE_FORCEINLINE_HINT int32 UE::Core::Private::FTCHARToUTF8_Convert::ConvertedLength ( const SrcBufferType *  Source, int32  SourceLen  )

inlinestatic

Determines the length of the converted string.

Returns

The length of the string in UTF-8 code units.

Utf8FromCodepoint()

template<typename BufferType >

static int32 UE::Core::Private::FTCHARToUTF8_Convert::Utf8FromCodepoint ( uint32  Codepoint, BufferType  OutputIterator, uint32  OutputIteratorByteSizeRemaining  )

inlinestatic

Convert Codepoint into UTF-8 characters.

Parameters

Codepoint	Codepoint to expand into UTF-8 bytes
OutputIterator	Output iterator to write UTF-8 bytes into
OutputIteratorByteSizeRemaining	Maximum number of ANSI characters that can be written to OutputIterator

Returns

Number of characters written for Codepoint

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Core/Public/Containers/StringConv.h