Metodo IDebugFAEntryTags::GetProperties (extsfns.h)

2025-02-06

Il metodo GetProperties ottiene il nome o la descrizione (o entrambi) di un tag in un oggetto DebugFailureAnalysisTags.

Sintassi

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

Parametri

Tag

Valore nell'enumerazione FA_TAG. Questo metodo ottiene il nome o la descrizione (o entrambi) di questo tag.

[out] Name

Puntatore a un buffer che riceve una stringa con terminazione Null che corrisponde al nome del tag. Se nameSize è minore della lunghezza del nome del tag, questo metodo copia solo nameSize byte, incluso il terminatore NULL, nel buffer.

[in, out] NameSize

In caso di input, questo parametro specifica le dimensioni, in byte, del buffer a cui punta Nome. Nell'output, questo parametro riceve le dimensioni, in byte, del nome del tag. Se il tag non ha alcun nome, questo parametro riceve un valore pari a 0.

Nota Se Nome è NULL, questo parametro non riceve informazioni. È necessario impostare sia Name che NameSize su valori non NULL oppure impostarli entrambi su NULL.

[out] Description

Puntatore a un buffer che riceve una stringa con terminazione Null che rappresenta la descrizione del tag. Se DescSize è minore della lunghezza della descrizione del tag, questo metodo copia solo byte DescSize, incluso il carattere di terminazione NULL, in questo buffer.

[in, out] DescSize

In caso di input, questo parametro specifica le dimensioni, in byte, del buffer a cui punta Descrizione. Nell'output, questo parametro riceve le dimensioni, in byte, della descrizione del tag. Se il tag non contiene alcuna descrizione, questo parametro riceve un valore pari a 0.

Nota Se Description è NULL, questo parametro non riceve informazioni. È consigliabile impostare sia Description che DescSize su valori non NULL oppure impostarli entrambi su NULL.

[out] Flags

Riservato. Impostare questo parametro su NULL.

Valore restituito

I valori HRESULT restituiti da questo metodo sono definiti in winerror.h e strsafe.h. I valori restituiti da questo metodo includono, ma non sono limitati ai seguenti:

Codice restituito	Descrizione
S_OK	Questo metodo ha recuperato correttamente il nome o la descrizione richiesta (o entrambi) e non è stato richiesto alcun troncamento della stringa o delle stringhe richieste.
STRSAFE_E_INSUFFICIENT_BUFFER	Questo metodo ha recuperato il nome o la descrizione richiesti (o entrambi), ma il nome o la descrizione è stato troncato.
STRSAFE_E_INVALID_PARAMETER	Il chiamante ha passato almeno un parametro non valido.