String property. More...

#include <mb_property.h>

Inheritance diagram for StringProperty:

Collaboration diagram for StringProperty:

Public Member Functions
	StringProperty (MbePrompt name, const TCHAR *initValue, bool change=true)
	Constructor by parameters. More...

virtual	~StringProperty ()
	Destructor.

PrePropType	IsA () const override
	Get type of property.

void	GetCharValue (TCHAR *v) const override
	Get string value of the property. Deprecated method, use GetCharValue_s() in combination with GetCharLen() instead.

size_t	GetCharLen () const override
	Get buffer size, sufficient to accommodate the string value of the property. More...

bool	GetCharValue_s (TCHAR *v, size_t size) const override
	Get the string value of the property as a string with a terminal null. More...

void	_GetPropertyValue (void *v, size_t size) const override
	Get value of the property.

void	SetPropertyValue (TCHAR *v) override
	Set the new value of the property.

Public Member Functions inherited from MbProperty
	MbProperty (MbePrompt name, bool change=true)
	Constructor by parameters. More...

virtual	~MbProperty ()
	Destructor.

virtual void	GetProperties (MbProperties &)
	Get tuple of the complex property (non-atomic object).

virtual void	SetProperties (const MbProperties &)
	Set tuple of the complex property (non-atomic object).

virtual size_t	GetPrompt () const
	Get a hint.

MbePrompt &	SetPrompt ()
	Get a hint.

bool	IsChangeable () const
	Is it possible to change data.

Detailed Description

String property.

String property is intended for reading and changing TCHAR * like data.

Constructor & Destructor Documentation

◆ StringProperty()

StringProperty::StringProperty	(	MbePrompt	name,
		const TCHAR *	initValue,
		bool	change = `true`
	)

Constructor by parameters.

Constructor by parameters. The maximum string length is limited to 128 characters. If the length of the initialization string is longer, the string-value is truncated.

Parameters

[in]	name	- Number of hint string.
[in]	initValue	- Initialization string.
[in]	change	- The flag of editability.

Member Function Documentation

◆ GetCharLen()

size_t StringProperty::GetCharLen ( ) const

overridevirtual

Get buffer size, sufficient to accommodate the string value of the property.

Returns buffer size, sufficient to accommodate the string value of the property, excluding the terminal null.

Reimplemented from MbProperty.

◆ GetCharValue_s()

bool StringProperty::GetCharValue_s	(	TCHAR *	v,
		size_t	size
	)		const