Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvString Class Reference

String class. More...

Public Member Functions

 PvString ()
 Default constructor.
 
 PvString (const PvString &aValue)
 Copy constructor. More...
 
 PvString (const char *aValue)
 Constructor. More...
 
 PvString (const wchar_t *aValue)
 Constructor. More...
 
virtual ~PvString ()
 Destructor.
 
const PvStringoperator= (const PvString &aValue)
 Assignment operator. More...
 
const PvStringoperator+= (const PvString &aValue)
 Concatenation operator. More...
 
bool operator== (const char *aValue) const
 Test for equality with a multibyte string. More...
 
bool operator!= (const char *aValue) const
 Test for inequality with a multibyte string. More...
 
bool operator== (const wchar_t *aValue) const
 Test for equality with a unicode string. More...
 
bool operator!= (const wchar_t *aValue) const
 Test for inequality with a unicode string. More...
 
bool operator== (const PvString &aValue) const
 Test for equality with another PvString object. More...
 
bool operator!= (const PvString &aValue) const
 Test for inequality with another PvString object. More...
 
 operator const char * () const
 Multibyte string cast operator. More...
 
 operator const wchar_t * () const
 Unicast string cast operator. More...
 
const char * GetAscii () const
 Get the string in ASCII format. More...
 
const wchar_t * GetUnicode () const
 Get the string in Unicode format. More...
 
unsigned int GetLength () const
 Get the string's length. More...
 

Detailed Description

String class.

Constructor & Destructor Documentation

PvString::PvString ( const PvString aValue)

Copy constructor.

Parameters
[in]aValueThe string you want to initialize this PvString with.
PvString::PvString ( const char *  aValue)

Constructor.

Parameters
[in]aValueThe string you want to initialize this PvString with.
PvString::PvString ( const wchar_t *  aValue)

Constructor.

Parameters
[in]aValueThe string you want to initialize this PvString with.

Member Function Documentation

const char * PvString::GetAscii ( ) const

Get the string in ASCII format.

Do not store. Copy the string if needed out of the current context.

Returns
The string, converted to ASCII.
See also
GetUnicode
unsigned int PvString::GetLength ( ) const

Get the string's length.

Returns
The length of the string, in characters.
const wchar_t * PvString::GetUnicode ( ) const

Get the string in Unicode format.

Do not store. Copy the string if needed out of the current context.

Returns
The string, converted to Unicode.
See also
GetAscii
PvString::operator const char * ( ) const

Multibyte string cast operator.

Do not store. Copy the string if needed out of the current context.

Returns
Pointer to a multibyte string.
PvString::operator const wchar_t * ( ) const

Unicast string cast operator.

Do not store. Copy the string if needed out of the current context.

Returns
The string, cast as unicode data.
bool PvString::operator!= ( const char *  aValue) const

Test for inequality with a multibyte string.

Case sensitive.

Parameters
[in]aValueThe string to compare against.
Returns
True if the strings are not equal; otherwise, false.
bool PvString::operator!= ( const wchar_t *  aValue) const

Test for inequality with a unicode string.

Case sensitive.

Parameters
[in]aValueThe string to compare against.
Returns
True if the strings are not equal; otherwise, false.
bool PvString::operator!= ( const PvString aValue) const

Test for inequality with another PvString object.

Case sensitive.

Parameters
[in]aValueThe string to compare against.
Returns
True if the strings are not equal; otherwise, false.
const PvString & PvString::operator+= ( const PvString aValue)

Concatenation operator.

Parameters
[in]aValueThe string to be appended to the current string.
Returns
This updated PvString.
const PvString & PvString::operator= ( const PvString aValue)

Assignment operator.

Parameters
[in]aValueThe string's new value.
Returns
This updated PvString.
bool PvString::operator== ( const char *  aValue) const

Test for equality with a multibyte string.

Case sensitive.

Parameters
[in]aValueThe The string to compare against.
Returns
True if the strings are equal; otherwise, false.
bool PvString::operator== ( const wchar_t *  aValue) const

Test for equality with a unicode string.

Case sensitive.

Parameters
[in]aValueThe string to compare against.
Returns
True if the strings are equal; otherwise, false.
bool PvString::operator== ( const PvString aValue) const

Test for equality with another PvString object.

Case sensitive.

Parameters
[in]aValueThe string to compare against.
Returns
True if the strings are the same; otherwise, false.

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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com