CrashRptProbe.h

Go to the documentation of this file.

/************************************************************************************* 
This file is a part of CrashRpt library.
Copyright (c) 2003-2013 The CrashRpt project authors. All Rights Reserved.

Use of this source code is governed by a BSD-style license
that can be found in the License.txt file in the root of the source
tree. All contributing project authors may
be found in the Authors.txt file in the root of the source tree.
***************************************************************************************/

#ifndef __CRASHRPT_PROBE_H__
#define __CRASHRPT_PROBE_H__

#ifdef __cplusplus
#define CRASHRPTPROBE_EXTERNC extern "C"
#else
#define CRASHRPTPROBE_EXTERNC
#endif

// Define SAL macros to be empty if some old Visual Studio used
#ifndef __reserved
#define __reserved
#endif
#ifndef __in
#define __in
#endif
#ifndef __in_opt
#define __in_opt
#endif
#ifndef __out
#define __out
#endif
#ifndef __out_ecount
#define __out_ecount(x)
#endif
#ifndef __out_ecount_z
#define __out_ecount_z(x)
#endif

#define CRASHRPTPROBE_API(rettype) CRASHRPTPROBE_EXTERNC rettype WINAPI

typedef int CrpHandle;

CRASHRPTPROBE_API(int)
crpOpenErrorReportW(
                    __in LPCWSTR pszFileName,
                    __in_opt LPCWSTR pszMd5Hash,
                    __in_opt LPCWSTR pszSymSearchPath,
                    __reserved DWORD dwFlags,
                    __out CrpHandle* phReport
                    );

CRASHRPTPROBE_API(int)
crpOpenErrorReportA(
                    __in LPCSTR pszFileName,
                    __in_opt LPCSTR pszMd5Hash,
                    __in_opt LPCSTR pszSymSearchPath,  
                    __reserved DWORD dwFlags,
                    __out CrpHandle* phReport
                    );

#ifdef UNICODE
#define crpOpenErrorReport crpOpenErrorReportW
#else
#define crpOpenErrorReport crpOpenErrorReportA
#endif //UNICODE

CRASHRPTPROBE_API(int) 
crpCloseErrorReport(
                    CrpHandle hReport  
                    );

/* Table names passed to crpGetProperty() function. */

#define CRP_TBL_XMLDESC_MISC _T("XmlDescMisc")                
#define CRP_TBL_XMLDESC_FILE_ITEMS _T("XmlDescFileItems")     
#define CRP_TBL_XMLDESC_CUSTOM_PROPS _T("XmlDescCustomProps") 
#define CRP_TBL_MDMP_MISC    _T("MdmpMisc")    
#define CRP_TBL_MDMP_MODULES _T("MdmpModules") 
#define CRP_TBL_MDMP_THREADS _T("MdmpThreads") 
#define CRP_TBL_MDMP_LOAD_LOG _T("MdmpLoadLog") 

/* Meta information */

#define CRP_META_ROW_COUNT _T("RowCount") 

/* Column names passed to crpGetProperty() function. */

// Columns IDs of the CRP_XMLDESC_MISC table
#define CRP_COL_CRASHRPT_VERSION _T("CrashRptVersion") 
#define CRP_COL_CRASH_GUID       _T("CrashGUID")       
#define CRP_COL_APP_NAME         _T("AppName")         
#define CRP_COL_APP_VERSION      _T("AppVersion")      
#define CRP_COL_IMAGE_NAME       _T("ImageName")       
#define CRP_COL_OPERATING_SYSTEM _T("OperatingSystem") 
#define CRP_COL_SYSTEM_TIME_UTC  _T("SystemTimeUTC")   
#define CRP_COL_EXCEPTION_TYPE   _T("ExceptionType")   
#define CRP_COL_EXCEPTION_CODE   _T("ExceptionCode")   
#define CRP_COL_INVPARAM_FUNCTION _T("InvParamFunction") 
#define CRP_COL_INVPARAM_EXPRESSION _T("InvParamExpression") 
#define CRP_COL_INVPARAM_FILE    _T("InvParamFile")    
#define CRP_COL_INVPARAM_LINE    _T("InvParamLine")    
#define CRP_COL_FPE_SUBCODE      _T("FPESubcode")      
#define CRP_COL_USER_EMAIL       _T("UserEmail")       
#define CRP_COL_PROBLEM_DESCRIPTION _T("ProblemDescription") 
#define CRP_COL_MEMORY_USAGE_KBYTES _T("MemoryUsageKbytes")  
#define CRP_COL_GUI_RESOURCE_COUNT _T("GUIResourceCount")    
#define CRP_COL_OPEN_HANDLE_COUNT  _T("OpenHandleCount")     
#define CRP_COL_OS_IS_64BIT  _T("OSIs64Bit")                 
#define CRP_COL_GEO_LOCATION _T("GeoLocation")               

// Column IDs of the CRP_XMLDESC_FILE_ITEMS table
#define CRP_COL_FILE_ITEM_NAME   _T("FileItemName")    
#define CRP_COL_FILE_ITEM_DESCRIPTION _T("FileItemDescription") 

// Column IDs of the CRP_XMLDESC_CUSTOM_PROPS table
#define CRP_COL_PROPERTY_NAME   _T("PropertyName")     
#define CRP_COL_PROPERTY_VALUE  _T("PropertyValue")    

// Column IDs of the CRP_MDMP_MISC table
#define CRP_COL_CPU_ARCHITECTURE _T("CPUArchitecture") 
#define CRP_COL_CPU_COUNT        _T("CPUCount")        
#define CRP_COL_PRODUCT_TYPE     _T("ProductType")     
#define CRP_COL_OS_VER_MAJOR     _T("OSVerMajor")      
#define CRP_COL_OS_VER_MINOR     _T("OSVerMinor")      
#define CRP_COL_OS_VER_BUILD     _T("OSVerBuild")      
#define CRP_COL_OS_VER_CSD       _T("OSVerCSD")        
#define CRP_COL_EXCPTRS_EXCEPTION_CODE _T("ExptrsExceptionCode")  
#define CRP_COL_EXCEPTION_ADDRESS _T("ExceptionAddress")          
#define CRP_COL_EXCEPTION_THREAD_ROWID _T("ExceptionThreadROWID") 
#define CRP_COL_EXCEPTION_THREAD_STACK_MD5  _T("ExceptionThreadStackMD5") 
#define CRP_COL_EXCEPTION_MODULE_ROWID _T("ExceptionModuleROWID") 

// Column IDs of the CRP_MDMP_MODULES table
#define CRP_COL_MODULE_NAME      _T("ModuleName")           
#define CRP_COL_MODULE_IMAGE_NAME _T("ModuleImageName")     
#define CRP_COL_MODULE_BASE_ADDRESS _T("ModuleBaseAddress") 
#define CRP_COL_MODULE_SIZE      _T("ModuleSize")           
#define CRP_COL_MODULE_LOADED_PDB_NAME _T("LoadedPDBName")  
#define CRP_COL_MODULE_LOADED_IMAGE_NAME _T("LoadedImageName")  
#define CRP_COL_MODULE_SYM_LOAD_STATUS _T("ModuleSymLoadStatus") 

// Column IDs of the CRP_MDMP_THREADS table
#define CRP_COL_THREAD_ID            _T("ThdeadID")           
#define CRP_COL_THREAD_STACK_TABLEID _T("ThreadStackTABLEID") 

// Column IDs of a stack trace table
#define CRP_COL_STACK_MODULE_ROWID     _T("StackModuleROWID")    
#define CRP_COL_STACK_SYMBOL_NAME      _T("StackSymbolName")     
#define CRP_COL_STACK_OFFSET_IN_SYMBOL _T("StackOffsetInSymbol") 
#define CRP_COL_STACK_SOURCE_FILE      _T("StackSourceFile")     
#define CRP_COL_STACK_SOURCE_LINE      _T("StackSourceLine")     
#define CRP_COL_STACK_ADDR_PC_OFFSET   _T("StackAddrPCOffset")   

// Column IDs of the CRP_MDMP_LOAD_LOG table
#define CRP_COL_LOAD_LOG_ENTRY _T("LoadLogEntry")   


CRASHRPTPROBE_API(int) 
crpGetPropertyW(
                CrpHandle hReport,
                LPCWSTR lpszTableId,
                LPCWSTR lpszColumnId,
                INT nRowIndex,
                __out_ecount_z(pcchBuffSize) LPWSTR lpszBuffer,
                ULONG cchBuffSize,
                __out PULONG pcchCount
                );

CRASHRPTPROBE_API(int) 
crpGetPropertyA(
                CrpHandle hReport,
                LPCSTR lpszTableId,
                LPCSTR lpszColumnId,
                INT nRowIndex,
                __out_ecount_z(pcchBuffSize) LPSTR lpszBuffer,
                ULONG cchBuffSize,
                __out PULONG pcchCount
                );

#ifdef UNICODE
#define crpGetProperty crpGetPropertyW
#else
#define crpGetProperty crpGetPropertyA
#endif //UNICODE

CRASHRPTPROBE_API(int) 
crpExtractFileW(
                CrpHandle hReport,
                LPCWSTR lpszFileName,
                LPCWSTR lpszFileSaveAs,
                BOOL bOverwriteExisting
                );

CRASHRPTPROBE_API(int) 
crpExtractFileA(
                CrpHandle hReport,
                LPCSTR lpszFileName,
                LPCSTR lpszFileSaveAs,
                BOOL bOverwriteExisting
                );

#ifdef UNICODE
#define crpExtractFile crpExtractFileW
#else
#define crpExtractFile crpExtractFileA
#endif //UNICODE

CRASHRPTPROBE_API(int)
crpGetLastErrorMsgW(
                    __out_ecount(cchBuffSize) LPWSTR pszBuffer, 
                    __in UINT cchBuffSize);

CRASHRPTPROBE_API(int)
crpGetLastErrorMsgA(
                    __out_ecount(cchBuffSize) LPSTR pszBuffer, 
                    __in UINT cchBuffSize);

#ifdef UNICODE
#define crpGetLastErrorMsg crpGetLastErrorMsgW
#else
#define crpGetLastErrorMsg crpGetLastErrorMsgA
#endif //UNICODE


#endif __CRASHRPT_PROBE_H__