System::Text::UTF7Encoding Class Reference

UTF-7 encoding. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <utf7_encoding.h>

Inherits System::Text::Encoding.

Public Member Functions

ASPOSECPP_SHARED_API UTF7Encoding ()
 Constructor.
 
ASPOSECPP_SHARED_API UTF7Encoding (bool allow_optionals)
 Constructor.
 
ASPOSECPP_SHARED_API bool operator== (const UTF7Encoding &other) const
 Compares encodings parameters.
 
ASPOSECPP_SHARED_API bool Equals (SharedPtr< Object > obj) override
 Compares with object.
 
ASPOSECPP_SHARED_API int GetHashCode () const override
 Gets encoding hash code.
 
ASPOSECPP_SHARED_API SharedPtr< ObjectClone () override
 Clones encoding object.
 
ASPOSECPP_SHARED_API int GetBytes (ArrayPtr< char_t > chars, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index) override
 Get the bytes that result from encoding a character buffer.
 
ASPOSECPP_SHARED_API int GetCharCount (ArrayPtr< uint8_t > bytes, int index, int count) override
 Get the number of characters needed to decode a byte buffer.
 
ASPOSECPP_SHARED_API int GetChars (ArrayPtr< uint8_t > bytes, int byte_index, int byte_count, ArrayPtr< char_t > chars, int char_index) override
 Get the characters that result from decoding a byte buffer.
 
ASPOSECPP_SHARED_API int GetMaxByteCount (int char_count) override
 Get the maximum number of bytes needed to encode a specified number of characters.
 
ASPOSECPP_SHARED_API int GetMaxCharCount (int byte_count) override
 Get the maximum number of characters needed to decode a specified number of bytes.
 
ASPOSECPP_SHARED_API DecoderPtr GetDecoder () override
 Get a decoder that forwards requests to this object.
 
ASPOSECPP_SHARED_API EncoderPtr GetEncoder () override
 Get an encoder that forwards requests to this object.
 
ASPOSECPP_SHARED_API int GetByteCount (const char_t *chars, int count) override
 Get the number of characters needed to encode a character buffer.
 
ASPOSECPP_SHARED_API int GetBytes (const char_t *chars, int char_count, uint8_t *bytes, int byte_count) override
 Get the bytes that result from encoding a character buffer.
 
ASPOSECPP_SHARED_API int GetBytes (const String &s, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index) override
 Get the bytes that result from encoding a character buffer.
 
ASPOSECPP_SHARED_API int GetCharCount (const uint8_t *bytes, int count) override
 Get the number of characters needed to decode a byte buffer.
 
ASPOSECPP_SHARED_API int GetChars (const uint8_t *bytes, int byte_count, char_t *chars, int char_count) override
 Get the characters that result from decoding a byte buffer.
 
ASPOSECPP_SHARED_API String GetString (ArrayPtr< uint8_t > bytes, int index, int count) override
 Decodes a buffer of bytes into a string.
 
virtual ASPOSECPP_SHARED_API int GetByteCount (ArrayPtr< char_t > chars, int index, int count)
 Get the number of characters needed to encode a character buffer.
 
virtual ASPOSECPP_SHARED_API int GetByteCount (System::Details::ArrayView< char_t > chars, int index, int count)
 Get the number of characters needed to encode a character buffer.
 
template<std::size_t N>
int GetByteCount (const System::Details::StackArray< char_t, N > &chars, int index, int count)
 Get the number of characters needed to encode a character buffer.
 
virtual ASPOSECPP_SHARED_API int GetByteCount (const String &s)
 Get the number of characters needed to encode a string.
 
virtual ASPOSECPP_SHARED_API int GetByteCount (ArrayPtr< char_t > chars)
 Get the number of characters needed to encode a character buffer.
 
virtual ASPOSECPP_SHARED_API int GetBytes (System::Details::ArrayView< char_t > chars, int char_index, int char_count, System::Details::ArrayView< uint8_t > bytes, int byte_index)
 Get the bytes that result from encoding a character buffer.
 
template<std::size_t SC, std::size_t SB>
int GetBytes (System::Details::StackArray< char_t, SC > &chars, int char_index, int char_count, System::Details::StackArray< uint8_t, SB > &bytes, int byte_index)
 Get the bytes that result from encoding a character buffer.
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (const String &s)
 Get the bytes that result from encoding a character buffer.
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (ArrayPtr< char_t > chars, int index, int count)
 Get the bytes that result from encoding a character buffer.
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (const System::Details::ArrayView< char_t > &chars, int index, int count)
 Get the bytes that result from encoding a character buffer.
 
template<std::size_t N>
ArrayPtr< uint8_t > GetBytes (const System::Details::StackArray< char_t, N > &chars, int index, int count)
 Get the bytes that result from encoding a character buffer.
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (ArrayPtr< char_t > chars)
 Get the bytes that result from encoding a character buffer.
 
virtual ASPOSECPP_SHARED_API int GetCharCount (ArrayPtr< uint8_t > bytes)
 Get the number of characters needed to decode a byte buffer.
 
virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > GetChars (ArrayPtr< uint8_t > bytes, int index, int count)
 Get the characters that result from decoding a byte buffer.
 
virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > GetChars (ArrayPtr< uint8_t > bytes)
 Get the characters that result from decoding a byte buffer.
 
virtual ASPOSECPP_SHARED_API String GetString (uint8_t *bytes, int byte_count)
 Decodes a buffer of bytes into a string.
 
virtual ASPOSECPP_SHARED_API String GetString (ArrayPtr< uint8_t > bytes)
 Decodes a buffer of bytes into a string.
 
virtual ASPOSECPP_SHARED_API String GetString (const System::Details::ArrayView< uint8_t > &bytes)
 Decodes a buffer of bytes into a string.
 
template<std::size_t N>
String GetString (System::Details::StackArray< uint8_t, N > &bytes)
 Decodes a buffer of bytes into a string.
 
virtual ASPOSECPP_SHARED_API String GetString (const System::Details::ArrayView< uint8_t > &bytes, int index, int count)
 Decodes a buffer of bytes into a string.
 
template<std::size_t N>
String GetString (System::Details::StackArray< uint8_t, N > bytes, int index, int count)
 Decodes a buffer of bytes into a string.
 
- Public Member Functions inherited from System::Text::Encoding
ASPOSECPP_SHARED_API bool Equals (SharedPtr< Object > obj) override
 Compares encodings.
 
virtual ASPOSECPP_SHARED_API int get_CodePage ()
 Gets Windows codepage ID.
 
virtual ASPOSECPP_SHARED_API int get_WindowsCodePage ()
 Gets Windows codepage ID.
 
virtual ASPOSECPP_SHARED_API String get_WebName ()
 Gets IANA-compatible encoding name.
 
virtual ASPOSECPP_SHARED_API String get_BodyName ()
 Gets mail agent body compatible encoding name.
 
virtual ASPOSECPP_SHARED_API String get_EncodingName ()
 Gets human-readable encoding name.
 
virtual ASPOSECPP_SHARED_API String get_HeaderName ()
 Gets mail agent header compatible encoding name.
 
virtual ASPOSECPP_SHARED_API bool get_IsSingleByte ()
 Checks whether encoding is single byte.
 
virtual ASPOSECPP_SHARED_API bool get_IsBrowserDisplay ()
 Checks whether encoding can be used in browser to display content.
 
virtual ASPOSECPP_SHARED_API bool get_IsBrowserSave ()
 Checks whether encoding can be used in browser to save content.
 
virtual ASPOSECPP_SHARED_API bool get_IsMailNewsDisplay ()
 Checks whether encoding can be used in mail client to display content.
 
virtual ASPOSECPP_SHARED_API bool get_IsMailNewsSave ()
 Checks whether encoding can be used in mail client to save content.
 
ASPOSECPP_SHARED_API bool get_IsReadOnly ()
 Checks whether encoding is read-only.
 
ASPOSECPP_SHARED_API DecoderFallbackPtr get_DecoderFallback () const
 Gets decoder fallback.
 
ASPOSECPP_SHARED_API void set_DecoderFallback (const DecoderFallbackPtr &value)
 Sets decoder fallback.
 
ASPOSECPP_SHARED_API const EncoderFallbackPtr get_EncoderFallback () const
 Gets encoder fallback.
 
ASPOSECPP_SHARED_API void set_EncoderFallback (const EncoderFallbackPtr &value)
 Sets encoder fallback.
 
template<std::size_t N>
int GetByteCount (const System::Details::StackArray< char_t, N > &chars, int index, int count)
 Get the number of characters needed to encode a character buffer.
 
template<std::size_t SC, std::size_t SB>
int GetBytes (System::Details::StackArray< char_t, SC > &chars, int char_index, int char_count, System::Details::StackArray< uint8_t, SB > &bytes, int byte_index)
 Get the bytes that result from encoding a character buffer.
 
template<std::size_t N>
ArrayPtr< uint8_t > GetBytes (const System::Details::StackArray< char_t, N > &chars, int index, int count)
 Get the bytes that result from encoding a character buffer.
 
template<std::size_t N>
String GetString (System::Details::StackArray< uint8_t, N > &bytes)
 Decodes a buffer of bytes into a string.
 
template<std::size_t N>
String GetString (System::Details::StackArray< uint8_t, N > bytes, int index, int count)
 Decodes a buffer of bytes into a string.
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetPreamble ()
 Returns a sequence of bytes that denotes the encoding (e. g. BOM).
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures.
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures.
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value.
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object.
 
int SharedCount () const
 Gets current value of shared reference counter.
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object.
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics.
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string.
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call.
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator.
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only.
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr.
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings.
 

Static Public Attributes

static constexpr int UTF7_CODE_PAGE = 65000
 Magic number used by Windows for UTF-7 codepage id.
 
- Static Public Attributes inherited from System::Text::Encoding
static constexpr int DEFAULT_CODE_PAGE = 0
 Default codepage value.
 

Additional Inherited Members

- Public Types inherited from System::Text::Encoding
typedef System::SharedPtr< EncodingPtr
 RTTI.
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type.
 
- Static Public Member Functions inherited from System::Text::Encoding
static ASPOSECPP_SHARED_API ArrayPtr< uint8_t > Convert (const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes)
 Converts bytes between two encodings.
 
static ASPOSECPP_SHARED_API ArrayPtr< uint8_t > Convert (const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes, int index, int count)
 Converts bytes between two encodings.
 
static ASPOSECPP_SHARED_API EncodingPtr get_ASCII ()
 Gets ASCII encoding.
 
static ASPOSECPP_SHARED_API EncodingPtr get_BigEndianUnicode ()
 Gets the standard big-endian Unicode encoding object.
 
static ASPOSECPP_SHARED_API EncodingPtr get_Unicode ()
 Gets the standard Unicode encoding object.
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF8 ()
 Gets the standard UTF-8 encoding object.
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF8Unmarked ()
 Only internal, to be used by the class libraries: Unmarked and non-input-validating.
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF32 ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_BigEndianUTF32 ()
 Gets the standard big-endian UTF-32 encoding object.
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF7 ()
 Gets the standard UTF-7 encoding object.
 
static EncodingPtr get_Latin1 ()
 Gets Latin1 encoding. FOR INTERNAL USE.
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (const String &name)
 Gets encoding by name.
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (int codepage)
 Gets encoding by codepage.
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 Gets encoding by codepage.
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (const String &name, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 Gets encoding by name.
 
static ASPOSECPP_SHARED_API EncodingPtr get_Default ()
 Gets default encoding.
 
static ASPOSECPP_SHARED_API ArrayPtr< EncodingInfoPtrGetEncodings ()
 Gets list of known encodings.
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference.
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference.
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr.
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style.
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style.
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct.
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
 
- Protected Member Functions inherited from System::Text::Encoding
ASPOSECPP_SHARED_API Encoding ()
 Default constructor.
 
ASPOSECPP_SHARED_API Encoding (int codepage)
 Constructor.
 
ASPOSECPP_SHARED_API Encoding (int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 Constructor.
 
 Encoding (const Details::EncodingInfoInternal *info)
 Internal constructor.
 
- Protected Attributes inherited from System::Text::Encoding
const Details::EncodingInfoInternal * m_info
 Pointer to internal encoding info.
 
const int m_codepage
 Code page identifier.
 
bool m_is_read_only = true
 Read-only flag.
 

Detailed Description

UTF-7 encoding. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ UTF7Encoding() [1/2]

ASPOSECPP_SHARED_API System::Text::UTF7Encoding::UTF7Encoding ( )

Constructor.

◆ UTF7Encoding() [2/2]

ASPOSECPP_SHARED_API System::Text::UTF7Encoding::UTF7Encoding ( bool allow_optionals)

Constructor.

Parameters
allow_optionalsWhether to encode (false) characters that are allowed to go unencoded or leave them as-is (true).

Member Function Documentation

◆ Clone()

ASPOSECPP_SHARED_API SharedPtr< Object > System::Text::UTF7Encoding::Clone ( )
overridevirtual

Clones encoding object.

Returns
Encoding object clone.

Reimplemented from System::Text::Encoding.

◆ Equals()

ASPOSECPP_SHARED_API bool System::Text::UTF7Encoding::Equals ( SharedPtr< Object > obj)
override

Compares with object.

Parameters
objObject to compare with.
Returns
True if obj is UTF7Encoding with same parameters, false otherwise.

◆ GetByteCount() [1/6]

virtual ASPOSECPP_SHARED_API int System::Text::Encoding::GetByteCount ( ArrayPtr< char_t > chars)
virtual

Get the number of characters needed to encode a character buffer.

Parameters
charsCharacters buffer.
Returns
Required buffer size.

Reimplemented from System::Text::Encoding.

◆ GetByteCount() [2/6]

virtual ASPOSECPP_SHARED_API int System::Text::Encoding::GetByteCount ( ArrayPtr< char_t > chars,
int index,
int count )
virtual

Get the number of characters needed to encode a character buffer.

Parameters
charsCharacters buffer.
indexSlice begin.
countSlice size.
Returns
Required buffer size.

Reimplemented from System::Text::Encoding.

◆ GetByteCount() [3/6]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetByteCount ( const char_t * chars,
int count )
overridevirtual

Get the number of characters needed to encode a character buffer.

Parameters
charsCharacters buffer.
countBuffer size.
Returns
Required buffer size.

Reimplemented from System::Text::Encoding.

◆ GetByteCount() [4/6]

virtual ASPOSECPP_SHARED_API int System::Text::Encoding::GetByteCount ( const String & s)
virtual

Get the number of characters needed to encode a string.

Parameters
sString to encode.
Returns
Required buffer size.

Reimplemented from System::Text::Encoding.

◆ GetByteCount() [5/6]

template<std::size_t N>
int System::Text::Encoding::GetByteCount ( const System::Details::StackArray< char_t, N > & chars,
int index,
int count )
inline

Get the number of characters needed to encode a character buffer.

Parameters
charsCharacters buffer.
indexSlice begin.
countSlice size.
Returns
Required buffer size.

◆ GetByteCount() [6/6]

virtual ASPOSECPP_SHARED_API int System::Text::Encoding::GetByteCount ( System::Details::ArrayView< char_t > chars,
int index,
int count )
virtual

Get the number of characters needed to encode a character buffer.

Parameters
charsCharacters buffer.
indexSlice begin.
countSlice size.
Returns
Required buffer size.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [1/10]

virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > System::Text::Encoding::GetBytes ( ArrayPtr< char_t > chars)
virtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
Returns
Buffer that holds representation of characters being encoded.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [2/10]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetBytes ( ArrayPtr< char_t > chars,
int char_index,
int char_count,
ArrayPtr< uint8_t > bytes,
int byte_index )
overridevirtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
char_indexCharacter slice beginning.
char_countNumber of characters to convert.
bytesBuffer to put characters to.
byte_indexOutput buffer offset.
Returns
Number of written bytes.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [3/10]

virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > System::Text::Encoding::GetBytes ( ArrayPtr< char_t > chars,
int index,
int count )
virtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
indexCharacter slice beginning.
countNumber of characters to convert.
Returns
Buffer that holds representation of characters being encoded.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [4/10]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetBytes ( const char_t * chars,
int char_count,
uint8_t * bytes,
int byte_count )
overridevirtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
char_countNumber of characters to convert.
bytesBuffer to put characters to.
byte_countOutput buffer size.
Returns
Number of written bytes.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [5/10]

virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > System::Text::Encoding::GetBytes ( const String & s)
virtual

Get the bytes that result from encoding a character buffer.

Parameters
sString to encode.
Returns
Buffer that holds representation of characters being encoded.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [6/10]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetBytes ( const String & s,
int char_index,
int char_count,
ArrayPtr< uint8_t > bytes,
int byte_index )
overridevirtual

Get the bytes that result from encoding a character buffer.

Parameters
sString to encode.
char_indexCharacter slice beginning.
char_countNumber of characters to convert.
bytesBuffer to put characters to.
byte_indexOutput buffer offset.
Returns
Number of written bytes.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [7/10]

virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > System::Text::Encoding::GetBytes ( const System::Details::ArrayView< char_t > & chars,
int index,
int count )
virtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
indexCharacter slice beginning.
countNumber of characters to convert.
Returns
Buffer that holds representation of characters being encoded.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [8/10]

template<std::size_t N>
ArrayPtr< uint8_t > System::Text::Encoding::GetBytes ( const System::Details::StackArray< char_t, N > & chars,
int index,
int count )
inline

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
indexCharacter slice beginning.
countNumber of characters to convert.
Returns
Buffer that holds representation of characters being encoded.

◆ GetBytes() [9/10]

virtual ASPOSECPP_SHARED_API int System::Text::Encoding::GetBytes ( System::Details::ArrayView< char_t > chars,
int char_index,
int char_count,
System::Details::ArrayView< uint8_t > bytes,
int byte_index )
virtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
char_indexCharacter slice beginning.
char_countNumber of characters to convert.
bytesBuffer to put characters to.
byte_indexOutput buffer offset.
Returns
Number of written bytes.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [10/10]

template<std::size_t SC, std::size_t SB>
int System::Text::Encoding::GetBytes ( System::Details::StackArray< char_t, SC > & chars,
int char_index,
int char_count,
System::Details::StackArray< uint8_t, SB > & bytes,
int byte_index )
inline

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
char_indexCharacter slice beginning.
char_countNumber of characters to convert.
bytesBuffer to put characters to.
byte_indexOutput buffer offset.
Returns
Number of written bytes.

◆ GetCharCount() [1/3]

virtual ASPOSECPP_SHARED_API int System::Text::Encoding::GetCharCount ( ArrayPtr< uint8_t > bytes)
virtual

Get the number of characters needed to decode a byte buffer.

Parameters
bytesBytes to decode.
Returns
Number of characters.

Reimplemented from System::Text::Encoding.

◆ GetCharCount() [2/3]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetCharCount ( ArrayPtr< uint8_t > bytes,
int index,
int count )
overridevirtual

Get the number of characters needed to decode a byte buffer.

Parameters
bytesBytes to decode.
indexSlice beginning.
countSlice size.
Returns
Number of characters.

Reimplemented from System::Text::Encoding.

◆ GetCharCount() [3/3]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetCharCount ( const uint8_t * bytes,
int count )
overridevirtual

Get the number of characters needed to decode a byte buffer.

Parameters
bytesBytes to decode.
countBytes count.
Returns
Number of characters.

Reimplemented from System::Text::Encoding.

◆ GetChars() [1/4]

virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > System::Text::Encoding::GetChars ( ArrayPtr< uint8_t > bytes)
virtual

Get the characters that result from decoding a byte buffer.

Parameters
bytesBuffer to read bytes from.
Returns
Buffer of decoded characters.

Reimplemented from System::Text::Encoding.

◆ GetChars() [2/4]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetChars ( ArrayPtr< uint8_t > bytes,
int byte_index,
int byte_count,
ArrayPtr< char_t > chars,
int char_index )
overridevirtual

Get the characters that result from decoding a byte buffer.

Parameters
bytesBuffer to read bytes from.
byte_indexInput buffer offset.
byte_countInput buffer size.
charsBuffer to put characters to.
char_indexOutput buffer offset.
Returns
Number of written characters.

Reimplemented from System::Text::Encoding.

◆ GetChars() [3/4]

virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > System::Text::Encoding::GetChars ( ArrayPtr< uint8_t > bytes,
int index,
int count )
virtual

Get the characters that result from decoding a byte buffer.

Parameters
bytesBuffer to read bytes from.
indexInput buffer offset.
countInput buffer size.
Returns
Buffer of decoded characters.

Reimplemented from System::Text::Encoding.

◆ GetChars() [4/4]

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetChars ( const uint8_t * bytes,
int byte_count,
char_t * chars,
int char_count )
overridevirtual

Get the characters that result from decoding a byte buffer.

Parameters
bytesBuffer to read bytes from.
byte_countInput buffer size.
charsBuffer to put characters to.
char_countOutput buffer size.
Returns
Number of written characters.

Reimplemented from System::Text::Encoding.

◆ GetDecoder()

ASPOSECPP_SHARED_API DecoderPtr System::Text::UTF7Encoding::GetDecoder ( )
overridevirtual

Get a decoder that forwards requests to this object.

Returns
Newly created decoder.

Reimplemented from System::Text::Encoding.

◆ GetEncoder()

ASPOSECPP_SHARED_API EncoderPtr System::Text::UTF7Encoding::GetEncoder ( )
overridevirtual

Get an encoder that forwards requests to this object.

Returns
Newly created encoder.

Reimplemented from System::Text::Encoding.

◆ GetHashCode()

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetHashCode ( ) const
overridevirtual

Gets encoding hash code.

Returns
Hash code value.

Reimplemented from System::Text::Encoding.

◆ GetMaxByteCount()

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetMaxByteCount ( int char_count)
overridevirtual

Get the maximum number of bytes needed to encode a specified number of characters.

Parameters
char_countNumber of characters to encode.
Returns
Number of bytes sufficient to encode any string of given character length.

Implements System::Text::Encoding.

◆ GetMaxCharCount()

ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetMaxCharCount ( int byte_count)
overridevirtual

Get the maximum number of characters needed to decode a specified number of bytes.

Parameters
byte_countNumber of bytes to decode.
Returns
Number of bytes sufficient to decode any string of given character length.

Implements System::Text::Encoding.

◆ GetString() [1/7]

virtual ASPOSECPP_SHARED_API String System::Text::Encoding::GetString ( ArrayPtr< uint8_t > bytes)
virtual

Decodes a buffer of bytes into a string.

Parameters
bytesBuffer to read bytes from.
Returns
String of decoded characters.

Reimplemented from System::Text::Encoding.

◆ GetString() [2/7]

ASPOSECPP_SHARED_API String System::Text::UTF7Encoding::GetString ( ArrayPtr< uint8_t > bytes,
int index,
int count )
overridevirtual

Decodes a buffer of bytes into a string.

Parameters
bytesBuffer to read bytes from.
indexInput buffer offset.
countInput buffer size.
Returns
String of decoded characters.

Reimplemented from System::Text::Encoding.

◆ GetString() [3/7]

virtual ASPOSECPP_SHARED_API String System::Text::Encoding::GetString ( const System::Details::ArrayView< uint8_t > & bytes)
virtual

Decodes a buffer of bytes into a string.

Parameters
bytesBuffer to read bytes from.
Returns
String of decoded characters.

Reimplemented from System::Text::Encoding.

◆ GetString() [4/7]

virtual ASPOSECPP_SHARED_API String System::Text::Encoding::GetString ( const System::Details::ArrayView< uint8_t > & bytes,
int index,
int count )
virtual

Decodes a buffer of bytes into a string.

Parameters
bytesBuffer to read bytes from.
indexInput buffer offset.
countInput buffer size.
Returns
String of decoded characters.

Reimplemented from System::Text::Encoding.

◆ GetString() [5/7]

template<std::size_t N>
String System::Text::Encoding::GetString ( System::Details::StackArray< uint8_t, N > & bytes)
inline

Decodes a buffer of bytes into a string.

Parameters
bytesBuffer to read bytes from.
Returns
String of decoded characters.

◆ GetString() [6/7]

template<std::size_t N>
String System::Text::Encoding::GetString ( System::Details::StackArray< uint8_t, N > bytes,
int index,
int count )
inline

Decodes a buffer of bytes into a string.

Parameters
bytesBuffer to read bytes from.
indexInput buffer offset.
countInput buffer size.
Returns
String of decoded characters.

◆ GetString() [7/7]

virtual ASPOSECPP_SHARED_API String System::Text::Encoding::GetString ( uint8_t * bytes,
int byte_count )
virtual

Decodes a buffer of bytes into a string.

Parameters
bytesBuffer to read bytes from.
byte_countInput buffer size.
Returns
String of decoded characters.

Reimplemented from System::Text::Encoding.

◆ operator==()

ASPOSECPP_SHARED_API bool System::Text::UTF7Encoding::operator== ( const UTF7Encoding & other) const

Compares encodings parameters.

Parameters
otherEncoding to compare parameters with.
Returns
True if parameters match, false otherwise.

Member Data Documentation

◆ UTF7_CODE_PAGE

int System::Text::UTF7Encoding::UTF7_CODE_PAGE = 65000
staticconstexpr

Magic number used by Windows for UTF-7 codepage id.