System::Security::SecureString Class Referencefinal

Inherits System::IDisposable.

Public Member Functions

ASPOSECPP_SHARED_API SecureString ()
 RTTI information. More...
 
ASPOSECPP_SHARED_API SecureString (const char16_t *value, int32_t length)
 
ASPOSECPP_SHARED_API ~SecureString ()
 Destructor. More...
 
 SecureString (const SecureString &)=delete
 
SecureStringoperator= (const SecureString &)=delete
 
ASPOSECPP_SHARED_API int32_t get_Length () const
 Gets number of characters in this secure string. More...
 
ASPOSECPP_SHARED_API void AppendChar (char16_t c)
 
ASPOSECPP_SHARED_API void Clear ()
 Delete all characters from the current secure string. More...
 
ASPOSECPP_SHARED_API SecureStringPtr Copy () const
 Creates a duplicate of this secure string. More...
 
ASPOSECPP_SHARED_API void InsertAt (int32_t index, char16_t c)
 
ASPOSECPP_SHARED_API bool IsReadOnly () const
 Gets flag that indicates whether this object is marked read-only. More...
 
ASPOSECPP_SHARED_API void MakeReadOnly ()
 Makes this secure string read-only. More...
 
ASPOSECPP_SHARED_API void RemoveAt (int32_t index)
 
ASPOSECPP_SHARED_API void SetAt (int32_t index, char16_t c)
 
ASPOSECPP_SHARED_API void Dispose () override
 Release all resources used by the current object. More...
 
ASPOSECPP_SHARED_API String ToUnsecureString () const
 
- 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 reference 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 bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Secure string, represents text that should be kept confidential. This class DON'T ENCRYPTING the internal data. 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

◆ SecureString() [1/3]

ASPOSECPP_SHARED_API System::Security::SecureString::SecureString ( )

RTTI information.

Default constructor.

◆ SecureString() [2/3]

ASPOSECPP_SHARED_API System::Security::SecureString::SecureString ( const char16_t *  value,
int32_t  length 
)

Constructor.

Parameters
valueA pointer to an array of characters.
lengthThe number of elements in value array.

◆ ~SecureString()

ASPOSECPP_SHARED_API System::Security::SecureString::~SecureString ( )

Destructor.

◆ SecureString() [3/3]

System::Security::SecureString::SecureString ( const SecureString )
delete

Member Function Documentation

◆ AppendChar()

ASPOSECPP_SHARED_API void System::Security::SecureString::AppendChar ( char16_t  c)

Appends a character to the end of the string.

Parameters
cA character to append.

◆ Clear()

ASPOSECPP_SHARED_API void System::Security::SecureString::Clear ( )

Delete all characters from the current secure string.

◆ Copy()

ASPOSECPP_SHARED_API SecureStringPtr System::Security::SecureString::Copy ( ) const

Creates a duplicate of this secure string.

◆ Dispose()

ASPOSECPP_SHARED_API void System::Security::SecureString::Dispose ( )
overridevirtual

Release all resources used by the current object.

Reimplemented from System::IDisposable.

◆ get_Length()

ASPOSECPP_SHARED_API int32_t System::Security::SecureString::get_Length ( ) const

Gets number of characters in this secure string.

◆ InsertAt()

ASPOSECPP_SHARED_API void System::Security::SecureString::InsertAt ( int32_t  index,
char16_t  c 
)

Inserts a character at the specified index.

Parameters
indexThe position where character is inserted.
cA character to insert.

◆ IsReadOnly()

ASPOSECPP_SHARED_API bool System::Security::SecureString::IsReadOnly ( ) const

Gets flag that indicates whether this object is marked read-only.

◆ MakeReadOnly()

ASPOSECPP_SHARED_API void System::Security::SecureString::MakeReadOnly ( )

Makes this secure string read-only.

◆ operator=()

SecureString& System::Security::SecureString::operator= ( const SecureString )
delete

◆ RemoveAt()

ASPOSECPP_SHARED_API void System::Security::SecureString::RemoveAt ( int32_t  index)

Removes the character at the specified position.

Parameters
indexThe position of a character.

◆ SetAt()

ASPOSECPP_SHARED_API void System::Security::SecureString::SetAt ( int32_t  index,
char16_t  c 
)

Replaces the existing character at the specified position.

Parameters
indexThe position of a character.
cA new character.

◆ ToUnsecureString()

ASPOSECPP_SHARED_API String System::Security::SecureString::ToUnsecureString ( ) const

Copies contents of this secure string into unsecure String object. Use with caution.

Returns
Unsecure string.