api_docs_2025-0/Utf16_8hpp_source.html

//

//  Copyright Phoenix Contact GmbH & Co. KG

//

#pragma once

#include "Arp/System/Core/Arp.h"

#include "Arp/System/Commons/Encoding/EncodingResult.hpp"


namespace Arp { namespace System { namespace Commons { namespace Encoding

{


class Utf16

{

public: // construction/destruction/assignment

    Utf16(void) = delete;


public: // static operations

    static EncodingResult ConvertToUtf8(const char16* pInput, size_t inputLength, char8* pResult, size_t resultCapacity, size_t& resultLength);

    static EncodingResult ConvertToUtf8(const char16* pInput, size_t inputLength, String& result);


    static EncodingResult ConvertFromUtf8(const char8* pInput, size_t inputLength, char16* pResult, size_t resultCapacity, size_t& resultLength);

    static EncodingResult ConvertFromUtf8(const String& input, char16* pResult, size_t resultCapacity, size_t& resultLength);


private: // static methods

    static EncodingResult MapEncodingResult(int value);

};


}}}} // end of namespace Arp::System::Commons::Encoding

Arp.h

Arp::Base::Core::String
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39

Arp::System::Commons::Encoding::Utf16
This static class provides encoding string operations from UTF8 to UTF16 or vice versa.
Definition: Utf16.hpp:15

Arp::System::Commons::Encoding::Utf16::ConvertFromUtf8
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.
Definition: Utf16.cpp:109

Arp::System::Commons::Encoding::Utf16::ConvertToUtf8
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.
Definition: Utf16.cpp:21

Arp::Base::Core::char8
char char8
The Arp character type of 1 byte size.
Definition: PrimitiveTypes.hpp:45

Arp::Base::Core::char16
char16_t char16
The Arp character type of 2 byte size.
Definition: PrimitiveTypes.hpp:49

Arp::System::Commons::Encoding::EncodingResult
EncodingResult
This enum defines encoding results for operations of class Utf16.
Definition: EncodingResult.hpp:16

Arp
Root namespace for the PLCnext API