IDebugFailureAnalysis2::GetUlong method

The GetUlong64 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 ULONG64 value from the entry's data block.

Syntax


PFA_ENTRY GetUlong(
        FA_TAG   Tag,
  [out] PULONG64 Value
);

Parameters

Tag

A value in the FA_TAG enumeration.

Value [out]

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

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

If this method finds an FA entry with the specified tag, it checks to see whether the DataSize member of the FA_ENTRY structure is equal to the size of a ULONG64. If DataSize is not equal to the size of a ULONG64, this method returns NULL and does not get the data block.

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_ULONG64 or DEBUG_FA_ENTRY_INSTRUCTION_OFFSET or DEBUG_FA_ENTRY_POINTER.

Requirements

Target platform

Header

Extsfns.h

See also

IDebugFailureAnalysis2
Writing an Analysis Extension Plug-in to Extend !analyze
SetUlong64
AddUlong64
_EFN_Analyze

 

 

Send comments about this topic to Microsoft

Show: