IDebugFailureAnalysis2::SetBuffer method

The SetBuffer 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 overwrites the data block of the FA entry with the bytes in a specified buffer. If this method does not find an FA entry that has the specified tag, it creates a new FA entry with that tag and overwrites the data block of the new FA entry with the data in the specified buffer.

Syntax


FA_ENTRY SetBuffer(
       FA_TAG        Tag,
  [in] FA_ENTRY_TYPE EntryType,
  [in] PVOID         Buf,
  [in] ULONG         Size
);

Parameters

Tag

A value in the FA_TAG enumeration.

EntryType [in]

A value in the FA_ENTRY_TYPE enumeration. This parameter specifies the data type of the data in Buf.

Buf [in]

A pointer to a buffer that contains the bytes to be written to the data block of the new or existing FA entry.

Size [in]

The size, in bytes, of the buffer pointed to by Buf.

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 compatible with the data type specified by EntryType. For example, DEBUG_FA_ENTRY_ULONG64, DEBUG_FA_ENTRY_INSTRUCTION_OFFSET, and DEBUG_FA_ENTRY_POINTER are all compatible with each other. Likewise, DEBUG_FA_ENTRY_ANSI_STRING and DEBUG_FA_ENTRY_EXTENSION_CMD are compatible with each other. If the data types are not compatible, 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 specified by EntryType.

Requirements

Target platform

Desktop

Header

Extsfns.h

See also

IDebugFailureAnalysis2
Writing an Analysis Extension Plug-in to Extend !analyze
GetBuffer
AddBuffer
_EFN_Analyze

 

 

Send comments about this topic to Microsoft

Show: