xtd::security::secure_string Class Reference

Inheritance diagram for xtd::security::secure_string:

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.

Header

#include <xtd/security/secure_string>

Namespace

xtd::security

Library

xtd.core

Public Constructors
	secure_string ()=default
	Initializes a new instance of the xtd::security::secure_string class.
	secure_string (const char value[], xtd::usize 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.

Public Properties
auto	data () const noexcept -> intptr
	Gets underlying encrypted data.
auto	length () const noexcept -> xtd::usize
	Gets underlying encrypted data size.
auto	size () const noexcept -> xtd::usize
	Gets underlying encrypted data size.

Public Methods
auto	to_unsecure_string () const noexcept -> xtd::string
	Gets decrypted data.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

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[],
		xtd::usize	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

value	A pointer to an array of char.
length	The 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()

auto xtd::security::secure_string::data ( ) const -> intptr

nodiscardnoexcept

Gets underlying encrypted data.

Returns

The underlying encrypted data.

length()

auto xtd::security::secure_string::length ( ) const -> xtd::usize

nodiscardnoexcept

Gets underlying encrypted data size.

Returns

The underlying encrypted data size.

size()

auto xtd::security::secure_string::size ( ) const -> xtd::usize

nodiscardnoexcept

Gets underlying encrypted data size.

Returns

The underlying encrypted data size.

to_unsecure_string()

auto xtd::security::secure_string::to_unsecure_string ( ) const -> xtd::string

nodiscardnoexcept

Gets decrypted 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:

• xtd.core/include/xtd/security/secure_string.hpp