IDebugFAEntryTags::GetProperties-Methode (extsfns.h)

Artikel
08/07/2023

Die GetProperties-Methode ruft den Namen oder die Beschreibung (oder beides) 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-Enumeration . Diese Methode ruft den Namen oder die Beschreibung (oder beides) dieses Tags ab.

[out] Name

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

[in, out] NameSize

Bei der Eingabe gibt dieser Parameter die Größe des Puffers in Bytes an, auf den durch Name verwiesen wird. Bei der Ausgabe empfängt dieser Parameter die Größe des Namens des Tags in Bytes. Wenn das Tag keinen Namen hat, erhält dieser Parameter den Wert 0.

Hinweis Wenn Name NULL ist, empfängt dieser Parameter keine Informationen. Sie sollten sowohl Name als auch NameSize auf Werte ohne NULL festlegen oder beide auf NULL festlegen.

[out] Description

Ein Zeiger auf einen Puffer, der eine NULL-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-Abschlussators , in diesen Puffer.

[in, out] DescSize

Bei der Eingabe gibt dieser Parameter die Größe des Puffers in Bytes an, auf den die Beschreibung verweist. Bei der Ausgabe empfängt dieser Parameter die Größe der Beschreibung des Tags in Bytes. Wenn das Tag keine Beschreibung enthält, erhält dieser Parameter den Wert 0.

Hinweis Wenn Description NULL ist, empfängt dieser Parameter keine Informationen. Sie sollten entweder sowohl Description als auch DescSize auf Werte ohne NULL festlegen oder beide auf NULL festlegen.

[out] Flags

Reserviert. Legen Sie diesen Parameter auf NULL fest.

Rückgabewert

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

Rückgabecode	BESCHREIBUNG
S_OK	Diese Methode hat erfolgreich den angeforderten Namen oder die angeforderte Beschreibung (oder beides) abgerufen, und es war kein Abschneiden 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.

Anforderungen

Anforderung	Wert
Zielplattform	Desktop
Kopfzeile	extsfns.h

Weitere Informationen

IDebugFAEntryTags

IDebugFailureAnalysis2

SetProperties

Schreiben eines Analyseerweiterungs-Plug-Ins zum Erweitern von !analyze

_EFN_Analyze

Freigeben über