структура winrt::hstring (C++/WinRT)
Последовательная коллекция символов Юникода UTF-16, представляющая текстовую строку. Дополнительные примеры и сведения о winrt::hstringсм. в обработке строк вC++/WinRT.
Тип winrt::hstring инкапсулирует HSTRING за интерфейсом, похожим на std::wstring.
HSTRING — это дескриптор строки среды выполнения Windows. Сведения о настройке
struct hstring
минимальный поддерживаемый пакет SDK: windows SDK версии 10.0.17134.0 (Windows 10 версии 1803)
пространство имен : winrt
заголовок : %WindowsSdkDir%Include<WindowsTargetPlatformVersion>\cppwinrt\winrt\base.h (включен по умолчанию)
Имя псевдонима | Тип |
---|---|
hstring::value_type | Синоним wchar_t. |
hstring::size_type | Синоним uint32_t. |
hstring::const_reference | Синоним hstring::value_type const&. |
hstring::const_pointer | Синоним hstring::value_type const*. |
hstring::const_iterator | Синоним hstring::const_pointer. |
hstring::const_reverse_iterator | Синоним std::reverse_iterator<hstring::const_iterator>. |
Конструктор | Описание |
---|---|
конструктор hstring::hstring | Инициализирует новый экземпляр структуры hstring с копией входных строковых данных. |
Функция | Описание |
---|---|
hstring::back function | Возвращает ссылку на последний символ в объекте hstring. |
hstring::begin function | Возвращает константный итератор первому символу в объекте hstring. |
функция hstring::c_str | Возвращает указатель на базовую строку стиля C, завершаемую значением NULL, символов в объекте hstring; копирование не производится. |
hstring::cbegin function | Возвращает константный итератор первому символу в объекте hstring. |
hstring::cend function | Возвращает константный итератор к одному за пределами (один за последним символом) объекта hstring. |
hstring::clear function | Делает объект hstring пустым. |
функция hstring::crbegin | Возвращает обратный итератор констант в один за пределами (один за последним символом) объекта hstring. |
hstring::crend function | Возвращает обратный итератор констант к первому символу в объекте hstring. |
hstring::d ata function | Возвращает строку, завершающуюся значением NULL, версию символов в объекте hstring. |
hstring::empty function | Возвращает значение, указывающее, является ли объект hstring пустым. |
hstring::end function | Возвращает константный итератор к одному за пределами (один за последним символом) объекта hstring. |
hstring::front function | Возвращает ссылку на первый символ в объекте hstring. |
функция hstring::rbegin | Возвращает обратный итератор констант в один за пределами (один за последним символом) объекта hstring. |
функция hstring::rend | Возвращает обратный итератор констант к первому символу в объекте hstring. |
функция hstring::size | Возвращает количество символов в объекте hstring. |
Оператор | Описание |
---|---|
hstring::operator std::wstring_view | Преобразует объект hstring |
hstring::operator[] (оператор subscript)) | Возвращает ссылку на символ в указанной позиции в объекте hstring. |
hstring::operator= (оператор назначения) | Назначает значение объекту hstring. |
Функция | Описание |
---|---|
attach_abi функции | Присоединяет объект |
функция copy_from_abi | Копирует в объект hstring из дескриптора в строку среды выполнения Windows. Очищает hstring, копирует параметр и начинает управлять дескриптором. |
copy_to_abi функции | Копирует в дескриптор в строку среды выполнения Windows из объекта hstring. |
detach_abi функции | Отсоединяет объект hstring от его дескриптора, возможно, чтобы вернуть его вызывающему объекту. |
функция to_hstring | Преобразует входное значение в winrt::hstring, содержащую строковое представление значения. |
Оператор | Описание |
---|---|
оператор!= (оператор неравенства) | Возвращает значение, указывающее, не совпадают ли два параметра друг с другом. |
оператора |
Возвращает новый объект hstring, полученный из объединения двух параметров. |
оператор< (оператор меньше, чем оператор) | Возвращает значение, указывающее, меньше ли первый параметр, чем второй параметр. |
оператор <= (оператор меньше или равно) | Возвращает значение, указывающее, меньше ли первый параметр или равен второму параметру. |
оператор == (оператор равенства) | Возвращает значение, указывающее, равны ли два параметра друг другу. |
оператор> (оператор больше) | Возвращает значение, указывающее, больше ли первый параметр, чем второй параметр. |
оператор >= (оператор больше или равно) | Возвращает значение, указывающее, больше ли первый параметр или равен второму параметру. |
hstring — это диапазон, и этот диапазон определяется hstring::begin и hstring::end члены, каждый из которых возвращает итератор константа (как и hstring::cbegin и hstring::cend). Из-за этого можно перечислить символы в объекте hstring с оператором for
диапазона или с помощью функции шаблона std::for_each.
#include <iostream>
using namespace winrt;
...
void Iterators(hstring const& theHstring)
{
for (auto const& element : theHstring)
{
std::wcout << element;
}
std::for_each(theHstring.cbegin(), theHstring.cend(), [](T const& element) { std::wcout << element; });
}
Инициализирует новый экземпляр структуры hstring с копией входных строковых данных.
hstring() noexcept;
hstring(winrt::hstring const& h);
explicit hstring(std::wstring_view const& v);
hstring(wchar_t const* c);
hstring(wchar_t const* c, uint32_t s);
v
значение std::wstring_view, которое инициализирует объект hstring.
s
Число, указывающее фиксированный размер объекта hstring.
using namespace winrt;
...
void Constructors(
hstring const& theHstring,
std::wstring_view const& theWstringView,
wchar_t const* wideLiteral,
std::wstring const& wideString)
{
// hstring() noexcept
hstring fromDefault{};
// hstring(hstring const& h)
hstring fromHstring{ theHstring };
// explicit hstring(std::wstring_view const& value)
hstring fromWstringView{ theWstringView };
// hstring(wchar_t const* value)
hstring fromWideLiteral{ wideLiteral };
hstring fromWideString{ wideString.c_str() };
// hstring(wchar_t const* value, uint32_t size)
hstring fromWideLiteralWithSize{ wideLiteral, 256 };
hstring fromWideStringWithSize{ wideString.c_str(), 256 };
}
Возвращает ссылку на последний символ в объекте hstring.
wchar_t const& back() const noexcept;
Ссылка на последний символ в объекте hstring.
Возвращает константный итератор первому символу в объекте hstring. См. итераторов.
wchar_t const* begin() const noexcept;
Константный итератор к первому символу в объекте hstring.
Возвращает указатель на базовую строку стиля C, завершаемую значением NULL, символов в объекте hstring; копирование не производится.
wchar_t const* c_str() const noexcept;
Указатель на базовую строку стиля C, завершаемую null, символов в объекте hstring; копирование не производится.
#include <iostream>
using namespace winrt;
...
void PrintHstring(hstring const& theHstring)
{
// You can get a standard wide string from an hstring.
std::wcout << theHstring.c_str() << std::endl;
}
Возвращает константный итератор первому символу в объекте hstring. См. итераторов.
wchar_t const* cbegin() const noexcept;
Константный итератор к первому символу в объекте hstring.
Возвращает константный итератор к одному за пределами (один за последним символом) объекта hstring. См. итераторов.
wchar_t const* cend() const noexcept;
Константный итератор к одному за пределами (один за последним символом) объекта hstring.
Делает объект hstring пустым.
void clear() noexcept;
Возвращает обратный итератор констант в один за пределами (один за последним символом) объекта hstring.
std::reverse_iterator<wchar_t const*> crbegin() const noexcept;
Констант обратный итератор к одному за пределами (один за последним символом) объект hstring.
Возвращает обратный итератор констант к первому символу в объекте hstring.
std::reverse_iterator<wchar_t const*> crend() const noexcept;
Констант обратный итератор к первому символу в объекте hstring.
Возвращает строку, завершающуюся значением NULL, версию символов в объекте hstring.
wchar_t const* data() const noexcept;
Строка, завершающаяся значением NULL, в стиле C, версия символов в объекте
#include <iostream>
using namespace winrt;
...
void PrintHstring(hstring const& theHstring)
{
// You can get a standard wide string from an hstring.
std::wcout << theHstring.data() << std::endl;
}
Возвращает значение, указывающее, является ли объект hstring пустым.
bool empty() const noexcept;
true
, если объект hstring пуст, в противном случае false
.
Возвращает константный итератор к одному за пределами (один за последним символом) объекта hstring. См. итераторов.
wchar_t const* end() const noexcept;
Константный итератор к одному за пределами (один за последним символом) объекта hstring.
Возвращает ссылку на первый символ в объекте hstring.
wchar_t const& front() const noexcept;
Ссылка на первый символ в объекте hstring.
Преобразует объект hstring
operator std::wstring_view() const noexcept;
Объект hstring, преобразованный в std::wstring_view.
using namespace winrt;
...
Uri contosoUri{ L"https://www.contoso.com" };
Uri awUri{ L"https://www.adventure-works.com" };
// Uri::Domain() is of type hstring. But we can use hstring's conversion operator to std::wstring_view.
std::wstring domainWstring{ contosoUri.Domain() }; // L"contoso.com"
domainWstring = awUri.Domain(); // L"https://www.adventure-works.com"
Возвращает ссылку на символ в указанной позиции в объекте hstring.
wchar_t const& operator[](uint32_t pos) const noexcept;
pos
положение символов на основе нуля или индекс.
Ссылка на символ в указанной позиции в объекте hstring.
Назначает значение объекту hstring.
winrt::hstring& operator=(winrt::hstring const& h);
winrt::hstring& operator=(std::wstring_view const& v);
v
значение std::wstring_view для назначения объекту hstring.
Ссылка на объект hstring.
Возвращает обратный итератор констант в один за пределами (один за последним символом) объекта hstring.
std::reverse_iterator<wchar_t const*> rbegin() const noexcept;
Констант обратный итератор к одному за пределами (один за последним символом) объект hstring.
Возвращает обратный итератор констант к первому символу в объекте hstring.
std::reverse_iterator<wchar_t const*> rend() const noexcept;
Констант обратный итератор к первому символу в объекте hstring.
Возвращает количество символов в объекте hstring.
uint32_t size() const noexcept;
uint32_t, содержащий количество символов в объекте hstring.
Присоединяет объект
void attach_abi(winrt::hstring& object, HSTRING value) noexcept;
object
объект hstring для работы.
value
дескриптор строки среды выполнения Windows.
Копирует в объект hstring из дескриптора в строку среды выполнения Windows. Очищает hstring, копирует параметр и начинает управлять дескриптором.
void copy_from_abi(winrt::hstring& object, HSTRING value);
object
объект hstring для работы.
value
дескриптор строки среды выполнения Windows.
Копирует в дескриптор в строку среды выполнения Windows из объекта hstring.
void copy_to_abi(winrt::hstring const& object, HSTRING& value);
object
объект hstring для работы.
Отсоединяет объект hstring от его дескриптора, возможно, чтобы вернуть его вызывающему объекту.
HSTRING detach_abi(winrt::hstring& object) noexcept;
HSTRING detach_abi(winrt::hstring&& object) noexcept;
object
объект hstring для работы.
Дескриптор строки среды выполнения Windows.
Возвращает значение, указывающее, не совпадают ли два параметра друг с другом.
inline bool operator!=(winrt::hstring const& hLeft, winrt::hstring const& hRight) noexcept;
inline bool operator!=(winrt::hstring const& hLeft, std::wstring const& wRight) noexcept;
inline bool operator!=(winrt::hstring const& hLeft, wchar_t const* cRight) noexcept;
inline bool operator!=(std::wstring const& wLeft, winrt::hstring const& hRight) noexcept;
inline bool operator!=(wchar_t const* cLeft, winrt::hstring const& hRight) noexcept;
wLeft
wRight
значение std::wstring
для сравнения с другим параметром.
cLeft
cRight
Указатель на массив констант wchar_t для сравнения с другим параметром.
true
, если два параметра не равны друг другу, в противном случае false
.
Возвращает новый объект hstring, полученный из объединения двух параметров.
inline hstring operator+(winrt::hstring const& hLeft, winrt::hstring const& hRight);
inline hstring operator+(winrt::hstring const& hLeft, std::wstring const& wRight);
inline hstring operator+(winrt::hstring const& hLeft, std::wstring_view const& vRight);
inline hstring operator+(winrt::hstring const& hLeft, wchar_t const* cRight);
inline hstring operator+(winrt::hstring const& hLeft, wchar_t scRight);
inline hstring operator+(std::wstring const& wLeft, winrt::hstring const& hRight);
inline hstring operator+(std::wstring_view const& vLeft, winrt::hstring const& hRight);
inline hstring operator+(wchar_t const* cLeft, winrt::hstring const& hRight);
inline hstring operator+(wchar_t scLeft, winrt::hstring const& hRight);
wLeft
wRight
значение std::wstring
для объединения с другим параметром.
vLeft
vRight
значение std::wstring_view для объединения с другим параметром.
cLeft
cRight
Указатель на массив констант wchar_t для объединения с другим параметром.
scLeft
scRight
A wchar_t для объединения с другим параметром.
Новый объект hstring в результате объединения двух параметров.
Возвращает значение, указывающее, меньше ли первый параметр, чем второй параметр.
inline bool operator<(winrt::hstring const& hLeft, winrt::hstring const& hRight) noexcept;
inline bool operator<(winrt::hstring const& hLeft, std::wstring const& wRight) noexcept;
inline bool operator<(winrt::hstring const& hLeft, wchar_t const* cRight) noexcept;
inline bool operator<(std::wstring const& wLeft, winrt::hstring const& hRight) noexcept;
inline bool operator<(wchar_t const* cLeft, winrt::hstring const& hRight) noexcept;
wLeft
wRight
значение std::wstring
для сравнения с другим параметром.
cLeft
cRight
Указатель на массив констант wchar_t для сравнения с другим параметром.
true
, если первый параметр меньше второго параметра, в противном случае false
.
Возвращает значение, указывающее, меньше ли первый параметр или равен второму параметру.
inline bool operator<=(winrt::hstring const& hLeft, winrt::hstring const& hRight) noexcept;
inline bool operator<=(winrt::hstring const& hLeft, std::wstring const& wRight) noexcept;
inline bool operator<=(winrt::hstring const& hLeft, wchar_t const* cRight) noexcept;
inline bool operator<=(std::wstring const& wLeft, winrt::hstring const& hRight) noexcept;
inline bool operator<=(wchar_t const* cLeft, winrt::hstring const& hRight) noexcept;
wLeft
wRight
значение std::wstring
для сравнения с другим параметром.
cLeft
cRight
Указатель на массив констант wchar_t для сравнения с другим параметром.
true
, если первый параметр меньше или равен второму параметру, в противном случае false
.
Возвращает значение, указывающее, равны ли два параметра друг другу.
inline bool operator==(winrt::hstring const& hLeft, winrt::hstring const& hRight) noexcept;
inline bool operator==(winrt::hstring const& hLeft, std::wstring const& wRight) noexcept;
inline bool operator==(winrt::hstring const& hLeft, wchar_t const* cRight) noexcept;
inline bool operator==(std::wstring const& wLeft, winrt::hstring const& hRight) noexcept;
inline bool operator==(wchar_t const* cLeft, winrt::hstring const& hRight) noexcept;
wLeft
wRight
значение std::wstring
для сравнения с другим параметром.
cLeft
cRight
Указатель на массив констант wchar_t для сравнения с другим параметром.
true
, если два параметра равны друг другу, в противном случае false
.
Возвращает значение, указывающее, больше ли первый параметр, чем второй параметр.
inline bool operator>(winrt::hstring const& hLeft, winrt::hstring const& hRight) noexcept;
inline bool operator>(winrt::hstring const& hLeft, std::wstring const& wRight) noexcept;
inline bool operator>(winrt::hstring const& hLeft, wchar_t const* cRight) noexcept;
inline bool operator>(std::wstring const& wLeft, winrt::hstring const& hRight) noexcept;
inline bool operator>(wchar_t const* cLeft, winrt::hstring const& hRight) noexcept;
wLeft
wRight
значение std::wstring
для сравнения с другим параметром.
cLeft
cRight
Указатель на массив констант wchar_t для сравнения с другим параметром.
true
, если первый параметр больше второго параметра, в противном случае false
.
Возвращает значение, указывающее, больше ли первый параметр или равен второму параметру.
inline bool operator>=(winrt::hstring const& hLeft, winrt::hstring const& hRight) noexcept;
inline bool operator>=(winrt::hstring const& hLeft, std::wstring const& wRight) noexcept;
inline bool operator>=(winrt::hstring const& hLeft, wchar_t const* cRight) noexcept;
inline bool operator>=(std::wstring const& wLeft, winrt::hstring const& hRight) noexcept;
inline bool operator>=(wchar_t const* cLeft, winrt::hstring const& hRight) noexcept;
wLeft
wRight
значение std::wstring
для сравнения с другим параметром.
cLeft
cRight
Указатель на массив констант wchar_t для сравнения с другим параметром.
true
, если первый параметр больше или равен второму параметру, в противном случае false
.
- пространства имен winrt
- обработка строк в C++/WinRT