PLCnext API Documentation  22.9.0.33
Public Member Functions | Static Public Member Functions | List of all members
Arp::System::Commons::Encoding::Utf16 Class Reference

This static class provides encoding string operations from UTF8 to UTF16 or vice versa. More...

#include <Utf16.hpp>

Public Member Functions

 Utf16 (void)=delete
 Deleted constructor. More...
 
 Utf16 (const Utf16 &arg)=delete
 Deleted copy constructor. More...
 
 Utf16 (Utf16 &&arg) noexcept=delete
 Deleted move constructor. More...
 
Utf16operator= (const Utf16 &arg)=delete
 Deleted copy-assignment operator. More...
 
Utf16operator= (Utf16 &&arg) noexcept=delete
 Deleted move-assignment operator. More...
 
 ~Utf16 (void)=delete
 Deleted destructor. More...
 

Static Public Member Functions

static EncodingResult ConvertToUtf8 (const char16 *pInput, size_t inputLength, char8 *pResult, size_t resultCapacity, size_t &resultLength)
 This operation encodes an UTF16 string to an UTF8 string. More...
 
static EncodingResult ConvertFromUtf8 (const char8 *pInput, size_t inputLength, char16 *pResult, size_t resultCapacity, size_t &resultLength)
 This operation encodes an UTF8 string to an UTF16 string. More...
 

Detailed Description

This static class provides encoding string operations from UTF8 to UTF16 or vice versa.

Constructor & Destructor Documentation

◆ Utf16() [1/3]

Arp::System::Commons::Encoding::Utf16::Utf16 ( void  )
delete

Deleted constructor.

◆ Utf16() [2/3]

Arp::System::Commons::Encoding::Utf16::Utf16 ( const Utf16 arg)
delete

Deleted copy constructor.

◆ Utf16() [3/3]

Arp::System::Commons::Encoding::Utf16::Utf16 ( Utf16 &&  arg)
deletenoexcept

Deleted move constructor.

◆ ~Utf16()

Arp::System::Commons::Encoding::Utf16::~Utf16 ( void  )
delete

Deleted destructor.

Member Function Documentation

◆ ConvertFromUtf8()

static EncodingResult Arp::System::Commons::Encoding::Utf16::ConvertFromUtf8 ( const char8 pInput,
size_t  inputLength,
char16 pResult,
size_t  resultCapacity,
size_t &  resultLength 
)
static

This operation encodes an UTF8 string to an UTF16 string.

Parameters
pInputThe UTF8 input string to encode.
inputLengthThe length of the input string.
pResultThe resulting UTF16 string.
resultCapacityThe capacity of the given result string pResult .
resultLengthThe length of the resulting UTF16 string after encoding.
Returns
The encoding result.

◆ ConvertToUtf8()

static EncodingResult Arp::System::Commons::Encoding::Utf16::ConvertToUtf8 ( const char16 pInput,
size_t  inputLength,
char8 pResult,
size_t  resultCapacity,
size_t &  resultLength 
)
static

This operation encodes an UTF16 string to an UTF8 string.

Parameters
pInputThe UTF16 input string to encode.
inputLengthThe length of the input string.
pResultThe resulting UTF8 string.
resultCapacityThe capacity of the given result string pResult .
resultLengthThe length of the resulting UTF8 string after encoding.
Returns
The encoding result.

◆ operator=() [1/2]

Utf16& Arp::System::Commons::Encoding::Utf16::operator= ( const Utf16 arg)
delete

Deleted copy-assignment operator.

◆ operator=() [2/2]

Utf16& Arp::System::Commons::Encoding::Utf16::operator= ( Utf16 &&  arg)
deletenoexcept

Deleted move-assignment operator.


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