IDebugFAEntryTags::GetProperties-Methode (extsfns.h)

Artikel
02/06/2025

Die GetProperties- methode ruft den Namen oder die Beschreibung (oder beide) eines Tags in einem DebugFailureAnalysisTags-Objekt ab.

Syntax

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

Parameter

Tag

Ein Wert in der FA_TAG-Aufzählung. Diese Methode ruft den Namen oder die Beschreibung (oder beide) dieses Tags ab.

[out] Name

Ein Zeiger auf einen Puffer, der eine mit Null beendete Zeichenfolge empfängt, die den Namen des Tags darstellt. Wenn NameSize- kleiner als die Länge des Tagnamens ist, kopiert diese Methode nur NameSize Bytes, einschließlich des NULL- Terminators, in diesen Puffer.

[in, out] NameSize

Bei der Eingabe gibt dieser Parameter die Größe des Puffers in Byte an, auf den Nameverweist. Bei der Ausgabe empfängt dieser Parameter die Größe des Tags in Bytes. Wenn das Tag keinen Namen hat, empfängt dieser Parameter den Wert 0.

Hinweis Wenn Name NULL ist, empfängt dieser Parameter keine Informationen. Sie sollten entweder Name und NameSize- auf Nicht-NULL-Werte festlegen oder beide auf NULL-festlegen.

[out] Description

Ein Zeiger auf einen Puffer, der eine mit Null beendete Zeichenfolge empfängt, die die Beschreibung des Tags darstellt. Wenn DescSize- kleiner als die Länge der Beschreibung des Tags ist, kopiert diese Methode nur DescSize Bytes, einschließlich des NULL Terminator, in diesen Puffer.

[in, out] DescSize

Bei eingabe gibt dieser Parameter die Größe des Puffers in Byte an, auf den Descriptionverweist. Bei der Ausgabe empfängt dieser Parameter die Größe der Beschreibung des Tags in Bytes. Wenn das Tag keine Beschreibung aufweist, empfängt dieser Parameter den Wert 0.

Hinweis Wenn Description NULL ist, empfängt dieser Parameter keine Informationen. Sie sollten entweder Description und DescSize- auf Nicht-NULL-Werte festlegen oder beide auf NULL-festlegen.

[out] Flags

Reserviert. Legen Sie diesen Parameter auf NULL fest.

Rückgabewert

Die HRESULT- von dieser Methode zurückgegebenen Werte werden in "winerror.h" und "strsafe.h" definiert. Die von dieser Methode zurückgegebenen Werte sind enthalten, sind jedoch nicht auf Folgendes beschränkt:

Rückgabecode	Beschreibung
S_OK	Diese Methode hat den angeforderten Namen oder die angeforderte Beschreibung (oder beides) erfolgreich abgerufen, und es war keine Abkürzung der angeforderten Zeichenfolge oder Zeichenfolgen erforderlich.
STRSAFE_E_INSUFFICIENT_BUFFER	Diese Methode hat den angeforderten Namen oder die angeforderte Beschreibung (oder beides) abgerufen, aber der Name oder die Beschreibung wurde abgeschnitten.
STRSAFE_E_INVALID_PARAMETER	Der Aufrufer hat mindestens einen ungültigen Parameter übergeben.