IDebugFailureAnalysis::GetString-Methode (extsfns.h)

Artikel
02/29/2024

Die GetString-Methode durchsucht ein DebugFailureAnalysis-Objekt nach dem ersten FA-Eintrag , der über ein angegebenes Tag verfügt. Wenn es einen FA-Eintrag mit dem angegebenen Tag findet, ruft er den ANSI-Zeichenfolgenwert aus dem Datenblock des Eintrags ab.

Syntax

PFA_ENTRY GetString(
  [in]  FA_TAG Tag,
  [out] PSTR   Str,
  [in]  ULONG  MaxSize
);

Parameter

[in] Tag

Ein Wert in der FA_TAG-Enumeration .

[out] Str

Ein Zeiger auf einen Puffer, der den Zeichenfolgenwert aus dem Datenblock des Eintrags empfängt.

[in] MaxSize

Die Größe des Puffers in Bytes, auf den str verweist.

Rückgabewert

Wenn diese Methode einen FA-Eintrag mit dem angegebenen Tag findet und der Datenblock erfolgreich abrufen kann, gibt sie einen Zeiger auf die FA_ENTRY-Struktur zurück. Andernfalls wird NULL zurückgegeben.

Hinweise

Diese Methode kopiert eine NULL-beendete Zeichenfolge aus dem Datenblock des Eintrags in den Puffer, auf den str verweist. Diese Methode kopiert höchstens MaxSize-Zeichen , einschließlich des NULL-Abschlusszeichens.

Jedes Tag, das bereits in einem DebugFailureAnalysis-Objekt verwendet wurde, ist einem der Datentypen in der FA_ENTRY_TYPE-Enumeration zugeordnet. Um den einem Tag zugeordneten Datentyp zu bestimmen, rufen Sie die GetType-Methode der IDebugFAEntryTags-Schnittstelle auf. Um einen Zeiger auf eine IDebugFAEntryTags-Schnittstelle abzurufen, rufen Sie die GetDebugFATagControl-Methode der IDebugFailureAnalysis2-Schnittstelle auf.

Die geeignete Verwendung dieser Methode besteht darin, den Datenblock aus einem FA-Eintrag abzurufen, der über einen Datentyp von DEBUG_FA_ENTRY_ANSI_STRING verfügt.