IDebugFailureAnalysis2::GetUlong method

The GetString 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 gets the ANSI string value from the entry's data block.

Syntax


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

Parameters

Tag [in]

A value in the FA_TAG enumeration.

Str [out]

A pointer to a buffer that receives the string value from the entry's data block.

MaxSize [in]

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

Return value

If this method finds an FA entry with the specified tag, and if it succeeds in getting the data block, it returns a pointer to the FA_ENTRY structure. Otherwise, it returns NULL.

Remarks

This method copies a null-terminated string from the entry's data block to the buffer pointed to by Str. This method copies at most MaxSize characters including the NULL terminator.

Each tag that has already been used in a DebugFailureAnalysis object 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.

The appropriate use of this method is get the data block from an FA entry that has a data type of DEBUG_FA_ENTRY_ANSI_STRING.

Requirements

Header

Extsfns.h

See also

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

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft