SourcePawn::IContextTrace Class Reference

#include <sp_vm_api.h>

List of all members.


Detailed Description

Retrieves error information from a debug hook.

Definition at line 368 of file sp_vm_api.h.

Public Member Functions

virtual int GetErrorCode ()=0
 Returns the integer error code.
virtual const char * GetErrorString ()=0
 Returns a string describing the error.
virtual bool DebugInfoAvailable ()=0
 Returns whether debug info is available.
virtual const char * GetCustomErrorString ()=0
 Returns a custom error message.
virtual bool GetTraceInfo (CallStackInfo *trace)=0
 Returns trace info for a specific point in the backtrace, if any. The next subsequent call to GetTraceInfo() will return the next item in the call stack. Calls are retrieved in descending order (i.e. the first item is at the top of the stack/call sequence).
virtual void ResetTrace ()=0
 Resets the trace to its original position (the call on the top of the stack).
virtual const char * GetLastNative (uint32_t *index)=0
 Retrieves the name of the last native called. Returns NULL if there was no native that caused the error.


Member Function Documentation

virtual int SourcePawn::IContextTrace::GetErrorCode (  )  [pure virtual]

Returns the integer error code.

Returns:
Integer error code.

virtual const char* SourcePawn::IContextTrace::GetErrorString (  )  [pure virtual]

Returns a string describing the error.

Returns:
Error string.

virtual bool SourcePawn::IContextTrace::DebugInfoAvailable (  )  [pure virtual]

Returns whether debug info is available.

Returns:
True if debug info is available, false otherwise.

virtual const char* SourcePawn::IContextTrace::GetCustomErrorString (  )  [pure virtual]

Returns a custom error message.

Returns:
A pointer to a custom error message, or NULL otherwise.

virtual bool SourcePawn::IContextTrace::GetTraceInfo ( CallStackInfo trace  )  [pure virtual]

Returns trace info for a specific point in the backtrace, if any. The next subsequent call to GetTraceInfo() will return the next item in the call stack. Calls are retrieved in descending order (i.e. the first item is at the top of the stack/call sequence).

Parameters:
trace An ErrorTraceInfo buffer to store information (NULL to ignore).
Returns:
True if successful, false if there are no more traces.

virtual const char* SourcePawn::IContextTrace::GetLastNative ( uint32_t *  index  )  [pure virtual]

Retrieves the name of the last native called. Returns NULL if there was no native that caused the error.

Parameters:
index Optional pointer to store index.
Returns:
Native name, or NULL if none.


The documentation for this class was generated from the following file:
Generated on Thu Jan 4 13:34:37 2007 for SourcePawn JIT by  doxygen 1.5.1-p1