IDebugFailureAnalysis2::SetString method

The SetString method searches a DebugFailureAnalysis object for the first FA entry that has a specified tag. If it finds an FA entry with the specified tag, it sets (overwrites) the data block of the FA entry to a specified string value. If this method does not find an FA entry that has the specified tag, it creates a new FA entry with that tag and sets the data block of the new FA entry to the specified string value.

Syntax


FA_ENTRY SetString(
  FA_TAG Tag,
  [in]  PCSTR Str
);

Parameters

Tag

A value in the FA_TAG enumeration.

Str [in]

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

Return value

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

Remarks

If this method finds an FA entry with the specified tag, it checks to see whether the data type associated with that tag is DEBUG_FA_ENTRY_ANSI_STRING or DEBUG_FA_ENTRY_EXTENSION_CMD. If the data type associated with the tag is not one of those two types, this method returns NULL and does not overwrite the entry's data block.

If this method does not find an FA entry with the specified tag, it creates a new FA entry with that tag, and it associates the tag with the data type DEBUG_FA_ENTRY_ANSI_STRING.

Requirements

Header

Extsfns.h

See also

IDebugFailureAnalysis2
Writing an Analysis Extension Plug-in to Extend !analyze
GetString
AddString
_EFN_Analyze

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft