xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Member Functions | List of all members
xtd::security::secure_string Class Referencefinal

#include <secure_string.h>

Definition

Represents text that should be kept confidential, such as by deleting it from computer memory when no longer needed. This class cannot be inherited.

Namespace
xtd::security
Library
xtd.core

Public Member Functions

 secure_string ()=default
 Initializes a new instance of the xtd::security::secure_string class. More...
 
 secure_string (const char value[], size_t length)
 This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the xtd::security::secure_string class from a subarray of System.Char objects. More...
 
intptr_t data () const noexcept
 Gets underlying ripted data. More...
 
size_t size () const noexcept
 Gets underlying cripted data size. More...
 
std::string to_unsecure_string () const noexcept
 Gets decripted data. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a std::string that represents the current object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Constructor & Destructor Documentation

◆ secure_string() [1/2]

xtd::security::secure_string::secure_string ( )
default

Initializes a new instance of the xtd::security::secure_string class.

◆ secure_string() [2/2]

xtd::security::secure_string::secure_string ( const char  value[],
size_t  length 
)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the xtd::security::secure_string class from a subarray of System.Char objects.

Parameters
valueA pointer to an array of char.
lengthThe number of elements of value to include in the new instance.
Remarks
This constructor initializes the new xtd::security::secure_string object to the number of characters in value specified by length; the value of the instance is then encrypted.

Member Function Documentation

◆ data()

intptr_t xtd::security::secure_string::data ( ) const
noexcept

Gets underlying ripted data.

Returns
The underlying cripted data.

◆ size()

size_t xtd::security::secure_string::size ( ) const
noexcept

Gets underlying cripted data size.

Returns
The underlying cripted data size.

◆ to_unsecure_string()

std::string xtd::security::secure_string::to_unsecure_string ( ) const
noexcept

Gets decripted data.

A encrypted byte array.

Warning
This is a more convenient but less secure alternative to using xtd::security::secure_string::data.

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