IDebugFailureAnalysis2::AddString method (extsfns.h)

The AddString method adds a new FA entry to a DebugFailureAnalysis object and sets the data block of the FA entry to a specified string.

Syntax

PFA_ENTRY AddString(
       FA_TAG Tag,
  [in] PCSTR  Str
);

Parameters

Tag

A value in the FA_TAG enumeration. The data type associated with this tag must be DEBUG_FA_ENTRY_ANSI_STRING.

[in] Str

A pointer to a null-terminated ANSI string to be written to the data block of the new FA entry.

Return value

If this method succeeds, it returns a returns a pointer to the new FA_ENTRY structure. If this method fails, it returns NULL.

Remarks

This method sets the DataSize member of the new FA_ENTRY structure to the length, in bytes, of the string including the NULL terminator.

Each tag is associated with one of the data types in the FA_ENTRY_TYPE enumeration. To determine the data type associated with a tag, call the GetType method of the IDebugFAEntryTags interface.

To get a pointer to an IDebugFAEntryTags interface, call the GetDebugFATagControl method of the IDebugFailureAnalysis2 interface.

Requirements

Requirement Value
Target Platform Desktop
Header extsfns.h

See also

IDebugFAEntryTags

IDebugFailureAnalysis2

SetString

Writing an Analysis Extension Plug-in to Extend !analyze

_EFN_Analyze