//------------------------------------------------------------
// BCErrorInfoManager.GetErrorNumber
//
/// <summary></summary>
/// <param name="errID"></param>
/// <returns></returns>
//------------------------------------------------------------
internal int GetErrorNumber(ERRID errID)
{
ERRORINFO info = GetInfo(errID);
if (info != null)
{
return(info.ErrorNumber);
}
return(-1);
}
// NOTE: Warnings, errors, and fatal errors are determined by the
// various macros. ERRORDEF = ERROR_ERROR, FATALDEF = ERROR_FATAL
// WARNDEF and OLDWARN = ERROR_WARNING
// warning level value as follows:
//
// 0 = ERROR_ERROR
// >0 = ERROR_WARNING
// -1 = ERROR_FATAL
//------------------------------------------------------------
// BCErrorInfoManager.GetWarningLevel
//
/// <summary>
/// Return CSCSTRID for a given CSCERRID.
/// </summary>
/// <param name="errID"></param>
/// <returns></returns>
//------------------------------------------------------------
internal bool GetWarningLevel(ERRID errID, out int level)
{
level = -2;
ERRORINFO info = GetInfo(errID);
if (info != null)
{
level = info.WarningLevel;
return(true);
}
return(false);
}
//------------------------------------------------------------
// BCErrorInfoManager.GetErrorInfo (2)
//
/// <summary></summary>
/// <param name="errID"></param>
/// <param name="errNo"></param>
/// <param name="warnLevel"></param>
/// <returns></returns>
//------------------------------------------------------------
internal bool GetInfo(ERRID errID, out int errNo, out int warnLevel)
{
ERRORINFO info = GetInfo(errID);
if (info != null)
{
errNo = info.ErrorNumber;
warnLevel = info.WarningLevel;
return(true);
}
errNo = -1;
warnLevel = 4;
return(false);
}
//------------------------------------------------------------
// BCErrorInfoManager.GetResourceNumber (1)
//
/// <summary>
/// <para>Return the resource ID for a given CSCERRID.</para>
/// </summary>
/// <param name="errID"></param>
/// <param name="resNo"></param>
/// <returns></returns>
//------------------------------------------------------------
internal bool GetResourceNumber(
ERRID errID,
out ResNo resNo)
{
ERRORINFO info = GetInfo(errID);
if (info != null)
{
resNo = info.ResourceNumber;
return(true);
}
resNo = ResNo.Invalid;
return(false);
}
//------------------------------------------------------------
// BCErrorInfoManager.FormatErrorMessage (2)
//
/// <summary>
/// <para>Get the format string by id,
/// create an error message with args and locations</para>
/// </summary>
/// <param name="excp"></param>
/// <param name="errID"></param>
/// <param name="errKind"></param>
/// <param name="fileName"></param>
/// <param name="lineStart"></param>
/// <param name="colStart"></param>
/// <param name="lineEnd"></param>
/// <param name="colEnd"></param>
/// <param name="args"></param>
/// <returns></returns>
//------------------------------------------------------------
internal string FormatErrorMessage(
out Exception excp,
ERRID errID,
ERRORKIND errKind,
string fileName,
int lineStart,
int colStart,
int lineEnd,
int colEnd,
params Object[] args)
{
int errorNo = -1;
ResNo resNo = ResNo.Invalid;
ERRORINFO eInfo = GetInfo(errID);
if (eInfo != null)
{
errorNo = eInfo.ErrorNumber;
resNo = eInfo.ResourceNumber;
if (!ErrorUtil.IsValidErrorKind(errKind))
{
errKind = ErrorUtil.GetErrorKind(eInfo.WarningLevel);
}
}
else
{
resNo = ResNo.CSCSTR_InternalError;
args = new Object[] { "invalid error ID in CSResources.FormatErrorMessage" };
}
return(ErrorUtil.FormatErrorMessage(
out excp,
errKind,
this.Prefix,
errorNo,
resNo,
fileName,
lineStart,
colStart,
lineEnd,
colEnd,
args));
}
//------------------------------------------------------------
// BCErrorInfoManager.GetResourceNumber (2)
//
/// <summary>
/// <para>Return CSCSTRID for a given CSCERRID.</para>
/// <para>If not found, return 0 (no string is assigned to 0).</para>
/// </summary>
/// <param name="errID"></param>
/// <returns></returns>
//------------------------------------------------------------
internal ResNo GetResourceNumber(ERRID errID)
{
ERRORINFO info = GetInfo(errID);
return(info != null ? info.ResourceNumber : ResNo.Invalid);
}
virtual /* [local] */ HRESULT STDMETHODCALLTYPE GetBasicErrorInfo(
/* [in] */ ULONG ulRecordNum,
/* [out] */ ERRORINFO *pErrorInfo) = 0;
virtual /* [local] */ HRESULT STDMETHODCALLTYPE AddErrorRecord(
/* [in] */ ERRORINFO *pErrorInfo,
/* [in] */ DWORD dwLookupID,
/* [in] */ DISPPARAMS *pdispparams,
/* [in] */ IUnknown *punkCustomError,
/* [in] */ DWORD dwDynamicErrorID) = 0;
