Método IDebugFAEntryTags::GetProperties (extsfns.h)

Artigo
02/06/2025

O método GetProperties obtém o nome ou a descrição (ou ambos) de uma marca em um objeto DebugFailureAnalysisTags.

Sintaxe

HRESULT GetProperties(
            FA_TAG Tag,
  [out]     PSTR   Name,
  [in, out] PULONG NameSize,
  [out]     PSTR   Description,
  [in, out] PULONG DescSize,
  [out]     PULONG Flags
);

Parâmetros

Tag

Um valor na enumeração FA_TAG. Esse método obtém o nome ou a descrição (ou ambos) dessa marca.

[out] Name

Um ponteiro para um buffer que recebe uma cadeia de caracteres terminada em nulo que é o nome da marca. Se NameSize for menor que o comprimento do nome da marca, esse método copiará apenas NameSize bytes, incluindo o terminador NULL, para esse buffer.

[in, out] NameSize

Na entrada, esse parâmetro especifica o tamanho, em bytes, do buffer apontado por Name. Na saída, esse parâmetro recebe o tamanho, em bytes, do nome da marca. Se a marca não tiver nome, esse parâmetro receberá um valor de 0.

Observação Se Name for NULL, esse parâmetro não receberá nenhuma informação. Você deve definir Name e NameSize como valores não NULL ou defini-los como NULL.

[out] Description

Um ponteiro para um buffer que recebe uma cadeia de caracteres terminada em nulo que é a descrição da marca. Se DescSize for menor que o comprimento da descrição da marca, esse método copiará apenas DescSize bytes, incluindo o terminador de NULL, para esse buffer.

[in, out] DescSize

Na entrada, esse parâmetro especifica o tamanho, em bytes, do buffer apontado por Descrição. Na saída, esse parâmetro recebe o tamanho, em bytes, da descrição da marca. Se a marca não tiver nenhuma descrição, esse parâmetro receberá um valor de 0.

Observação Se Descrição for NULL, esse parâmetro não receberá nenhuma informação. Você deve definir Descrição e DescSize para valores não NULL ou defini-los para NULL.

[out] Flags

Reservado. Defina esse parâmetro como NULL.

Valor de retorno

Os valores HRESULT retornados por esse método são definidos em winerror.h e strsafe.h. Os valores retornados por esse método incluem, mas não estão limitados ao seguinte:

Código de retorno	Descrição
S_OK	Esse método recuperou com êxito o nome ou a descrição solicitado (ou ambos) e nenhum truncamento da cadeia de caracteres ou cadeias de caracteres solicitadas foi necessário.
STRSAFE_E_INSUFFICIENT_BUFFER	Esse método recuperou o nome ou a descrição solicitado (ou ambos), mas o nome ou a descrição foi truncado.
STRSAFE_E_INVALID_PARAMETER	O chamador passou pelo menos um parâmetro inválido.