Partilhar via


Classe HString

Uma classe auxiliar para gerenciar o tempo de vida de um HSTRING usando o padrão RAII.

Sintaxe

class HString;

Observações

O Tempo de Execução do Windows fornece acesso a cadeias de caracteres por meio de identificadores HSTRING . A HString classe fornece funções de conveniência e operadores para simplificar o uso de alças HSTRING. Essa classe pode lidar com o tempo de vida do HSTRING que possui por meio de um padrão RAII.

Members

Construtores Públicos

Nome Description
HString::HString Inicializa uma nova instância da HString classe.
HString::~HString Destrói a instância atual da HString classe.

Métodos Públicos

Nome Description
HString::Anexar Associa o objeto especificado HString ao objeto atual HString .
HString::CopyTo Copia o objeto atual HString para um objeto HSTRING.
HString::D etach Desassocia o objeto especificado HString de seu valor subjacente.
HString::Obter Recupera o valor do identificador HSTRING subjacente.
HString::GetAddressOf Recupera um ponteiro para a alça HSTRING subjacente.
HString::GetRawBuffer Recupera um ponteiro para os dados de cadeia de caracteres subjacentes.
HString::IsValid Indica se o objeto atual HString é válido.
HString::MakeReference Cria um HStringReference objeto a partir de um parâmetro de cadeia de caracteres especificado.
HString::Lançamento Exclui o valor da cadeia de caracteres subjacente e inicializa o objeto atual HString para um valor vazio.
HString::Conjunto Define o valor do objeto atual HString como a cadeia de caracteres ou parâmetro de caracteres HString largos especificado.

Operadores Públicos

Nome Description
HString::operador= Move o valor de outro HString objeto para o objeto atual HString .
HString::operador== Indica se os dois parâmetros são iguais.
HString::operador!= Indica se os dois parâmetros não são iguais.
HString::operator< Indica se o primeiro parâmetro é menor que o segundo.

Hierarquia de herança

HString

Requerimentos

Cabeçalho: corewrappers.h

Espaço de nomes: Microsoft::WRL::Wrappers

HString::~HString

Destrói a instância atual da HString classe.

~HString() throw()

HString::Anexar

Associa o objeto especificado HString ao objeto atual HString .

void Attach(
       HSTRING hstr
       ) throw()

Parâmetros

HSTR
Um objeto existente HString .

HString::CopyTo

Copia o objeto atual HString para um objeto HSTRING.

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

Parâmetros

STR
O HSTRING que recebe a cópia.

Observações

Esse método chama a função WindowsDuplicateString .

HString::D etach

Desassocia o objeto especificado HString de seu valor subjacente.

HSTRING Detach() throw()

Valor de retorno

O valor subjacente HString antes do início da operação de desanexação.

HString::Obter

Recupera o valor do identificador HSTRING subjacente.

HSTRING Get() const throw()

Valor de retorno

O valor do identificador HSTRING subjacente

HString::GetAddressOf

Recupera um ponteiro para a alça HSTRING subjacente.

HSTRING* GetAddressOf() throw()

Valor de retorno

Um ponteiro para a alça HSTRING subjacente.

Observações

Após essa operação, o valor da cadeia de caracteres do identificador HSTRING subjacente é destruído.

HString::GetRawBuffer

Recupera um ponteiro para os dados de cadeia de caracteres subjacentes.

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

Parâmetros

comprimento Ponteiro para uma int variável que recebe o comprimento dos dados.

Valor de retorno

Um const ponteiro para os dados de cadeia de caracteres subjacentes.

HString::HString

Inicializa uma nova instância da HString classe.

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

Parâmetros

HSTR
Uma alça HSTRING.

Outros
Um objeto existente HString .

Observações

O primeiro construtor inicializa um novo HString objeto que está vazio.

O segundo construtor inicializa um novo HString objeto para o valor do outro parâmetro existente e, em seguida, destrói o outro parâmetro.

HString::IsValid

Indica se o objeto atual HString está vazio ou não.

bool IsValid() const throw()

Parâmetros

true Se o objeto atual HString não estiver vazio, caso contrário, false.

HString::MakeReference

Cria um HStringReference objeto a partir de um parâmetro de cadeia de caracteres especificado.

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);

Parâmetros

tamanhoDest
Um parâmetro de modelo que especifica o tamanho do buffer de destino HStringReference .

STR
Uma referência a uma cadeia de caracteres largos.

Len
O comprimento máximo do buffer do parâmetro str a ser usado nesta operação. Se o parâmetro len não for especificado, todo o parâmetro str será usado.

Valor de retorno

Um HStringReference objeto cujo valor é o mesmo que o parâmetro str especificado.

HString::operator= Operador

Move o valor de outro HString objeto para o objeto atual HString .

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

Parâmetros

Outros
Um objeto existente HString .

Observações

O valor do outro objeto existente é copiado para o objeto atual HString e, em seguida, o outro objeto é destruído.

HString::operador== Operador

Indica se os dois parâmetros são iguais.

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()

Parâmetros

LHS
O primeiro parâmetro a comparar. lhs pode ser um HString objeto ou HStringReference ou um identificador HSTRING.

RHS
O segundo parâmetro a comparar. rhs pode ser um HString objeto ou HStringReference ou um identificador HSTRING.

Valor de retorno

true Se os parâmetros LHS e RHS forem iguais; caso contrário, false.

HString::operador!= Operador

Indica se os dois parâmetros não são iguais.

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()

Parâmetros

LHS
O primeiro parâmetro a comparar. lhs pode ser um HString objeto ou HStringReference ou um identificador HSTRING.

RHS
O segundo parâmetro a comparar. rhs pode ser um HString objeto ou HStringReference ou um identificador HSTRING.

Valor de retorno

true Se os parâmetros LHS e RHS não forem iguais; caso contrário, false.

HString::operator< Operador

Indica se o primeiro parâmetro é menor que o segundo.

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

Parâmetros

LHS
O primeiro parâmetro a comparar. LHS pode ser uma referência a um HStringarquivo .

RHS
O segundo parâmetro a comparar. rhs pode ser uma referência a um HStringarquivo .

Valor de retorno

true se o parâmetro lhs for inferior ao parâmetro rhs ; caso contrário, false.

HString::Lançamento

Exclui o valor da cadeia de caracteres subjacente e inicializa o objeto atual HString para um valor vazio.

void Release() throw()

HString::Conjunto

Define o valor do objeto atual HString como a cadeia de caracteres ou parâmetro de caracteres HString largos especificado.

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

Parâmetros

STR
Uma cadeia de caracteres larga.

Len
O comprimento máximo do parâmetro str atribuído ao objeto atual HString .

HSTR
Um objeto existente HString .