Udostępnij za pośrednictwem

HString — Klasa

  • Artykuł

Klasa pomocnika do zarządzania okresem istnienia HSTRING przy użyciu wzorca RAII.

Składnia

class HString;

Uwagi

Środowisko wykonawcze systemu Windows zapewnia dostęp do ciągów za pośrednictwem dojść HSTRING. Klasa HString zapewnia wygodne funkcje i operatory, aby uprościć korzystanie z uchwytów HSTRING. Ta klasa może obsługiwać okres istnienia HSTRING, który jest właścicielem za pomocą wzorca RAII.

Członkowie

Konstruktory publiczne

Nazwa/nazwisko opis
HString::HString Inicjuje nowe wystąpienie klasy HString.
HString::~HString Niszczy bieżące wystąpienie HString klasy.

Metody publiczne

Nazwa/nazwisko opis
HString::Attach Kojarzy określony HString obiekt z bieżącym HString obiektem.
HString::CopyTo Kopiuje bieżący HString obiekt do obiektu HSTRING.
HString::D etach Usuwa skojarzenie określonego HString obiektu z jego wartości bazowej.
HString::Get Pobiera wartość bazowego dojścia HSTRING.
HString::GetAddressOf Pobiera wskaźnik do bazowego dojścia HSTRING.
HString::GetRawBuffer Pobiera wskaźnik do danych ciągów bazowych.
HString::IsValid Wskazuje, czy bieżący HString obiekt jest prawidłowy.
HString::MakeReference HStringReference Tworzy obiekt na podstawie określonego parametru ciągu.
HString::Release Usuwa podstawową wartość ciągu i inicjuje bieżący HString obiekt do pustej wartości.
HString::Set Ustawia wartość bieżącego HString obiektu na określony ciąg lub HString parametr o szerokim znaku.

Operatory publiczne

Nazwa/nazwisko opis
HString::operator= Przenosi wartość innego HString obiektu do bieżącego HString obiektu.
HString::operator== Wskazuje, czy dwa parametry są równe.
HString::operator!= Wskazuje, czy dwa parametry nie są równe.
HString::operator< Wskazuje, czy pierwszy parametr jest mniejszy niż drugi parametr.

Hierarchia dziedziczenia

HString

Wymagania

Nagłówek: corewrappers.h

Przestrzeń nazw: Microsoft::WRL::Wrappers

HString::~HString

Niszczy bieżące wystąpienie HString klasy.

~HString() throw()

HString::Attach

Kojarzy określony HString obiekt z bieżącym HString obiektem.

void Attach(
       HSTRING hstr
       ) throw()

Parametry

hstr
Istniejący HString obiekt.

HString::CopyTo

Kopiuje bieżący HString obiekt do obiektu HSTRING.

HRESULT CopyTo(
   _Out_ HSTRING *str
   ) const throw();

Parametry

Str
HSTRING odbierający kopię.

Uwagi

Ta metoda wywołuje funkcję WindowsDuplicateString .

HString::D etach

Usuwa skojarzenie określonego HString obiektu z jego wartości bazowej.

HSTRING Detach() throw()

Wartość zwracana

Wartość bazowa HString przed rozpoczęciem operacji odłączania.

HString::Get

Pobiera wartość bazowego dojścia HSTRING.

HSTRING Get() const throw()

Wartość zwracana

Wartość bazowego uchwytu HSTRING

HString::GetAddressOf

Pobiera wskaźnik do bazowego dojścia HSTRING.

HSTRING* GetAddressOf() throw()

Wartość zwracana

Wskaźnik do bazowego uchwytu HSTRING.

Uwagi

Po wykonaniu tej operacji wartość ciągu bazowego dojścia HSTRING zostanie zniszczona.

HString::GetRawBuffer

Pobiera wskaźnik do danych ciągów bazowych.

const wchar_t* GetRawBuffer(unsigned int* length) const;

Parametry

length Wskaźnik do zmiennej int , która odbiera długość danych.

Wartość zwracana

Wskaźnik const do danych ciągów bazowych.

HString::HString

Inicjuje nowe wystąpienie klasy HString.

HString() throw();
HString(HString&& other) throw();

Parametry

hstr
Uchwyt HSTRING.

Innych
Istniejący HString obiekt.

Uwagi

Pierwszy konstruktor inicjuje nowy HString obiekt, który jest pusty.

Drugi konstruktor inicjuje nowy HString obiekt do wartości istniejącego innego parametru, a następnie niszczy drugi parametr.

HString::IsValid

Wskazuje, czy bieżący HString obiekt jest pusty, czy nie.

bool IsValid() const throw()

Parametry

true jeśli bieżący HString obiekt nie jest pusty; w przeciwnym razie false.

HString::MakeReference

HStringReference Tworzy obiekt na podstawie określonego parametru ciągu.

template<unsigned int sizeDest>
    static HStringReference MakeReference(
              wchar_t const (&str)[ sizeDest]);

    template<unsigned int sizeDest>
    static HStringReference MakeReference(
              wchar_t const (&str)[sizeDest],
              unsigned int len);

Parametry

sizeDest
Parametr szablonu określający rozmiar buforu docelowego HStringReference .

Str
Odwołanie do ciągu o szerokim znaku.

len
Maksymalna długość buforu parametru str do użycia w tej operacji. Jeśli parametr len nie zostanie określony, zostanie użyty cały parametr str.

Wartość zwracana

HStringReference Obiekt, którego wartość jest taka sama jak określony parametr str.

HString::operator=, operator

Przenosi wartość innego HString obiektu do bieżącego HString obiektu.

HString& operator=(HString&& other) throw()

Parametry

Innych
Istniejący HString obiekt.

Uwagi

Wartość istniejącego innego obiektu jest kopiowana do bieżącego HString obiektu, a następnie zostaje zniszczony inny obiekt.

HString::operator==, operator

Wskazuje, czy dwa parametry są równe.

inline bool operator==(
               const HString& lhs,
               const HString& rhs) throw()

inline bool operator==(
                const HString& lhs,
                const HStringReference& rhs) throw()

inline bool operator==(
                const HStringReference& lhs,
                const HString& rhs) throw()

inline bool operator==(
                 const HSTRING& lhs,
                 const HString& rhs) throw()

inline bool operator==(
                 const HString& lhs,
                 const HSTRING& rhs) throw()

Parametry

Lhs
Pierwszy parametr do porównania. Lhs może być obiektem HString lub HStringReference uchwytem HSTRING.

Rhs
Drugi parametr do porównania.Rhs może być HString obiektem lub HStringReference uchwytem HSTRING.

Wartość zwracana

truejeśli parametry lhs i rhs są równe; w przeciwnym razie , false.

HString::operator!= Operator

Wskazuje, czy dwa parametry nie są równe.

inline bool operator!=( const HString& lhs,
                        const HString& rhs) throw()

inline bool operator!=( const HStringReference& lhs,
                        const HString& rhs) throw()

inline bool operator!=( const HString& lhs,
                        const HStringReference& rhs) throw()

inline bool operator!=( const HSTRING& lhs,
                        const HString& rhs) throw()

inline bool operator!=( const HString& lhs,
                        const HSTRING& rhs) throw()

Parametry

Lhs
Pierwszy parametr do porównania. Lhs może być obiektem HString lub HStringReference uchwytem HSTRING.

Rhs
Drugi parametr do porównania.Rhs może być HString obiektem lub HStringReference uchwytem HSTRING.

Wartość zwracana

truejeśli parametry lhs i rhs nie są równe; w przeciwnym razie , false.

HString::operator<, operator

Wskazuje, czy pierwszy parametr jest mniejszy niż drugi parametr.

inline bool operator<(
    const HString& lhs,
    const HString& rhs) throw()

Parametry

Lhs
Pierwszy parametr do porównania. lhs może być odwołaniem do .HString

Rhs
Drugi parametr do porównania. Rhs może być odwołaniem do HString.

Wartość zwracana

truejeśli parametr lhs jest mniejszy niż parametr rhs; w przeciwnym razie , false.

HString::Release

Usuwa podstawową wartość ciągu i inicjuje bieżący HString obiekt do pustej wartości.

void Release() throw()

HString::Set

Ustawia wartość bieżącego HString obiektu na określony ciąg lub HString parametr o szerokim znaku.

HRESULT Set(
          const wchar_t* str) throw();
HRESULT Set(
          const wchar_t* str,
          unsigned int len
           ) throw();
HRESULT Set(
          const HSTRING& hstr
           ) throw();

Parametry

Str
Ciąg z szerokim znakiem.

len
Maksymalna długość parametru str przypisanego do bieżącego HString obiektu.

hstr
Istniejący HString obiekt.