System::Text::UTF7Encoding Class Reference

Inherits System::Text::Encoding.

Public Types

enum  : int { UTF7_CODE_PAGE = 65000 }
 
- Public Types inherited from System::Text::Encoding
typedef System::SharedPtr< EncodingPtr
 Pointer type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Public Member Functions

ASPOSECPP_SHARED_API UTF7Encoding ()
 Constructor. More...
 
ASPOSECPP_SHARED_API UTF7Encoding (bool allowOptionals)
 
ASPOSECPP_SHARED_API bool operator== (const UTF7Encoding &other) const
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj) override
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const override
 
virtual String get_EncodingName () override
 
virtual int get_CodePage () override
 
virtual bool get_IsSingleByte () override
 
virtual int GetByteCount (const ArrayPtr< char_t > &chars, int index, int count) override
 
virtual ASPOSECPP_SHARED_API int GetBytes (const ArrayPtr< char_t > &chars, int charIndex, int charCount, const ArrayPtr< uint8_t > &bytes, int byteIndex) override
 
virtual ASPOSECPP_SHARED_API int GetCharCount (const ArrayPtr< uint8_t > &bytes, int index, int count) override
 
virtual ASPOSECPP_SHARED_API int GetChars (const ArrayPtr< uint8_t > &bytes, int byteIndex, int byteCount, const ArrayPtr< char_t > &chars, int charIndex) override
 
virtual ASPOSECPP_SHARED_API int GetMaxByteCount (int charCount) override
 
virtual ASPOSECPP_SHARED_API int GetMaxCharCount (int byteCount) override
 
virtual ASPOSECPP_SHARED_API DecoderPtr GetDecoder () override
 
virtual ASPOSECPP_SHARED_API EncoderPtr GetEncoder () override
 
virtual ASPOSECPP_SHARED_API int GetByteCount (const char_t *chars, int count) override
 
virtual int GetByteCount (const String &s) override
 
virtual ASPOSECPP_SHARED_API int GetBytes (const char_t *chars, int charCount, uint8_t *bytes, int byteCount) override
 
virtual ASPOSECPP_SHARED_API int GetBytes (const String &s, int charIndex, int charCount, const ArrayPtr< uint8_t > &bytes, int byteIndex) override
 
virtual ArrayPtr< uint8_t > GetBytes (const String &s) override
 
virtual ASPOSECPP_SHARED_API int GetCharCount (const uint8_t *bytes, int count) override
 
virtual ASPOSECPP_SHARED_API int GetChars (const uint8_t *bytes, int byteCount, char_t *chars, int charCount) override
 
virtual ASPOSECPP_SHARED_API String GetString (const ArrayPtr< uint8_t > &bytes, int index, int count) override
 
- Public Member Functions inherited from System::Text::Encoding
virtual ASPOSECPP_SHARED_API int get_WindowsCodePage ()
 
virtual ASPOSECPP_SHARED_API String get_WebName ()
 
virtual ASPOSECPP_SHARED_API String get_BodyName ()
 
virtual ASPOSECPP_SHARED_API String get_HeaderName ()
 
virtual ASPOSECPP_SHARED_API bool get_IsBrowserDisplay ()
 
virtual ASPOSECPP_SHARED_API bool get_IsBrowserSave ()
 
virtual ASPOSECPP_SHARED_API bool get_IsMailNewsDisplay ()
 
virtual ASPOSECPP_SHARED_API bool get_IsMailNewsSave ()
 
virtual ASPOSECPP_SHARED_API bool get_IsReadOnly ()
 
virtual ASPOSECPP_SHARED_API DecoderFallbackPtr get_DecoderFallback () const
 
virtual ASPOSECPP_SHARED_API void set_DecoderFallback (const DecoderFallbackPtr value)
 
virtual ASPOSECPP_SHARED_API const EncoderFallbackPtr get_EncoderFallback () const
 
virtual ASPOSECPP_SHARED_API void set_EncoderFallback (const EncoderFallbackPtr value)
 
virtual ASPOSECPP_SHARED_API int GetByteCount (const ArrayPtr< char_t > &chars)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (const ArrayPtr< char_t > &chars, int index, int count)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (const ArrayPtr< char_t > &chars)
 
virtual ASPOSECPP_SHARED_API int GetCharCount (const ArrayPtr< uint8_t > &bytes)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > GetChars (const ArrayPtr< uint8_t > &bytes, int index, int count)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > GetChars (const ArrayPtr< uint8_t > &bytes)
 
virtual ASPOSECPP_SHARED_API String GetString (uint8_t *bytes, int byteCount)
 
virtual ASPOSECPP_SHARED_API String GetString (const ArrayPtr< uint8_t > &bytes)
 
virtual ASPOSECPP_SHARED_API SharedPtr< ObjectClone ()
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetPreamble ()
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
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. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Text::Encoding
static ASPOSECPP_SHARED_API ArrayPtr< uint8_t > Convert (const EncodingPtr &srcEncoding, const EncodingPtr &dstEncoding, const ArrayPtr< uint8_t > &bytes)
 
static ASPOSECPP_SHARED_API ArrayPtr< uint8_t > Convert (const EncodingPtr &srcEncoding, const EncodingPtr &dstEncoding, const ArrayPtr< uint8_t > &bytes, int index, int count)
 
static ASPOSECPP_SHARED_API EncodingPtr get_ASCII ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_BigEndianUnicode ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_Unicode ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF8 ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF8Unmarked ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF32 ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_BigEndianUTF32 ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF7 ()
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (const String &name)
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (int codepage)
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (int codepage, const EncoderFallbackPtr &encoderFallback, const DecoderFallbackPtr &decoderFallback)
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (const String &name, const EncoderFallbackPtr &encoderFallback, const DecoderFallbackPtr &decoderFallback)
 
static ASPOSECPP_SHARED_API EncodingPtr get_Default ()
 
static ASPOSECPP_SHARED_API System::ArrayPtr< System::SharedPtr< EncodingInfo > > GetEncodings ()
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
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. More...
 
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. More...
 
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. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Protected Member Functions inherited from System::Text::Encoding
ASPOSECPP_SHARED_API Encoding (int codePage_)
 
ASPOSECPP_SHARED_API void SetDefaultFallbacks ()
 Sets encoding and decoding fallbacks to default. More...
 
- Protected Attributes inherited from System::Text::Encoding
int codePage
 Codepage number. More...
 

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.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
UTF7_CODE_PAGE 

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

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  allowOptionals)

Constructor.

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

Member Function Documentation

◆ Equals()

virtual ASPOSECPP_SHARED_API bool System::Text::UTF7Encoding::Equals ( ptr  obj)
overridevirtual

Compares with object.

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

Reimplemented from System::Text::Encoding.

◆ get_CodePage()

virtual int System::Text::UTF7Encoding::get_CodePage ( )
inlineoverridevirtual

Gets encoding codepage.

Returns
Windows encoding codepage id.

Reimplemented from System::Text::Encoding.

◆ get_EncodingName()

virtual String System::Text::UTF7Encoding::get_EncodingName ( )
inlineoverridevirtual

Gets encoding name.

Returns
Hardcoded encoding name not including parameters.

Reimplemented from System::Text::Encoding.

◆ get_IsSingleByte()

virtual bool System::Text::UTF7Encoding::get_IsSingleByte ( )
inlineoverridevirtual

Checks if encoding stores character in single byte.

Returns
Always returns true.

Reimplemented from System::Text::Encoding.

◆ GetByteCount() [1/3]

virtual int System::Text::UTF7Encoding::GetByteCount ( const ArrayPtr< char_t > &  chars,
int  index,
int  count 
)
inlineoverridevirtual

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() [2/3]

virtual 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() [3/3]

virtual int System::Text::UTF7Encoding::GetByteCount ( const String s)
inlineoverridevirtual

Get the number of characters needed to encode a string.

Parameters
sString to encode.
Returns
Required buffer size.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [1/4]

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetBytes ( const ArrayPtr< char_t > &  chars,
int  charIndex,
int  charCount,
const ArrayPtr< uint8_t > &  bytes,
int  byteIndex 
)
overridevirtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
charIndexCharacter slice beginning.
charCountNumber of characters to convert.
bytesBuffer to put characters to.
byteIndexOutput buffer offset.
Returns
Number of written bytes.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [2/4]

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetBytes ( const char_t *  chars,
int  charCount,
uint8_t *  bytes,
int  byteCount 
)
overridevirtual

Get the bytes that result from encoding a character buffer.

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

Reimplemented from System::Text::Encoding.

◆ GetBytes() [3/4]

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetBytes ( const String s,
int  charIndex,
int  charCount,
const ArrayPtr< uint8_t > &  bytes,
int  byteIndex 
)
overridevirtual

Get the bytes that result from encoding a character buffer.

Parameters
sString to encode.
charIndexCharacter slice beginning.
charCountNumber of characters to convert.
bytesBuffer to put characters to.
byteIndexOutput buffer offset.
Returns
Number of written bytes.

Reimplemented from System::Text::Encoding.

◆ GetBytes() [4/4]

virtual ArrayPtr<uint8_t> System::Text::UTF7Encoding::GetBytes ( const String s)
inlineoverridevirtual

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.

◆ GetCharCount() [1/2]

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetCharCount ( const 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() [2/2]

virtual 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/2]

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetChars ( const ArrayPtr< uint8_t > &  bytes,
int  byteIndex,
int  byteCount,
const ArrayPtr< char_t > &  chars,
int  charIndex 
)
overridevirtual

Get the characters that result from decoding a byte buffer.

Parameters
bytesBuffer to read bytes from.
byteIndexInput buffer offset.
byteCountInput buffer size.
charsBuffer to put characters to.
charIndexOutput buffer offset.
Returns
Number of written characters.

Reimplemented from System::Text::Encoding.

◆ GetChars() [2/2]

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetChars ( const uint8_t *  bytes,
int  byteCount,
char_t *  chars,
int  charCount 
)
overridevirtual

Get the characters that result from decoding a byte buffer.

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

Reimplemented from System::Text::Encoding.

◆ GetDecoder()

virtual 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()

virtual 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()

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

Gets encoding hash code.

Returns
Hash code value.

Reimplemented from System::Text::Encoding.

◆ GetMaxByteCount()

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetMaxByteCount ( int  charCount)
overridevirtual

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

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

Implements System::Text::Encoding.

◆ GetMaxCharCount()

virtual ASPOSECPP_SHARED_API int System::Text::UTF7Encoding::GetMaxCharCount ( int  byteCount)
overridevirtual

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

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

Implements System::Text::Encoding.

◆ GetString()

virtual ASPOSECPP_SHARED_API String System::Text::UTF7Encoding::GetString ( const 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.

◆ 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.