Code:
/ Dotnetfx_Vista_SP2 / Dotnetfx_Vista_SP2 / 8.0.50727.4016 / DEVDIV / depot / DevDiv / releases / whidbey / NetFxQFE / ndp / fx / src / Misc / DbgUtil.cs / 1 / DbgUtil.cs
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
// SECREVIEW: This is a debug-only library that won't ship with retail builds.
//
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1801:AvoidUnusedParameters", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.AssertFinalization(System.Object,System.Boolean):System.Void")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.AssertFinalization(System.Object,System.Boolean):System.Void")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA902:MovePInvokesToNativeMethodsClass", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2101:SpecifyMarshalingForPInvokeStringArguments", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA902:MovePInvokesToNativeMethodsClass", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2205:UseManagedEquivalentsOfWin32Api", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.IsCriticalException(System.Exception):System.Boolean")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.StackFramesToStr(System.Int32):System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1818:DoNotConcatenateStringsInsideLoops", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.StackFramesToStr(System.Int32):System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Interoperability", "CA1404:CallGetLastErrorImmediatelyAfterPInvoke", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")]
#if WINFORMS_NAMESPACE
namespace System.Windows.Forms.Internal
#elif DRAWING_NAMESPACE
namespace System.Drawing.Internal
#else
namespace System.Internal
#endif
{
using System;
using System.Drawing;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
using System.Text;
using System.Runtime.InteropServices;
using System.Security.Permissions;
using System.Globalization;
///
/// Debug help utility.
///
[
ReflectionPermission(SecurityAction.Assert, TypeInformation=true, MemberAccess=true),
EnvironmentPermission(SecurityAction.Assert, Unrestricted=true),
FileIOPermission(SecurityAction.Assert, Unrestricted=true),
SecurityPermission(SecurityAction.Assert, Flags=SecurityPermissionFlag.UnmanagedCode),
UIPermission(SecurityAction.Assert, Unrestricted=true)
]
internal sealed class DbgUtil
{
public const int
FORMAT_MESSAGE_ALLOCATE_BUFFER = 0x00000100,
FORMAT_MESSAGE_IGNORE_INSERTS = 0x00000200,
FORMAT_MESSAGE_FROM_SYSTEM = 0x00001000,
FORMAT_MESSAGE_DEFAULT = FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_FROM_SYSTEM;
[DllImport(ExternDll.Kernel32, SetLastError=true, CharSet=System.Runtime.InteropServices.CharSet.Auto)]
public static extern int GetUserDefaultLCID();
[DllImport(ExternDll.Kernel32, SetLastError=true, CharSet=System.Runtime.InteropServices.CharSet.Auto)]
public static extern int FormatMessage(int dwFlags, HandleRef lpSource, int dwMessageId, int dwLanguageId, StringBuilder lpBuffer, int nSize, HandleRef arguments);
public static int gdipInitMaxFrameCount = 8;
public static int gdiUseMaxFrameCount = 8;
public static int finalizeMaxFrameCount = 5;
// Methods
///
/// Call this method from your Dispose(bool) to assert that unmanaged resources has been explicitly disposed.
///
[Conditional("DEBUG")] // This code will be compiled into the assembly anyways, it is up to the compiler to ignore the call.
public static void AssertFinalization(object obj, bool disposing)
{
#if GDI_FINALIZATION_WATCH
if( disposing || AppDomain.CurrentDomain.IsFinalizingForUnload() )
{
return;
}
try
{
BindingFlags bindingFlags = BindingFlags.NonPublic | BindingFlags.GetField | BindingFlags.Static | BindingFlags.Instance;
FieldInfo allocSiteFld = obj.GetType().GetField("AllocationSite", bindingFlags);
string allocationSite = allocSiteFld != null ? allocSiteFld.GetValue( obj ).ToString() : "";
// ignore ojects created by WindowsGraphicsCacheManager.
if( allocationSite.Contains("WindowsGraphicsCacheManager") )
{
return;
}
Debug.Fail("Object Disposed through finalization - it should be explicitly disposed.");
Debug.WriteLine("Allocation stack:\r\n" + allocationSite);
}
catch(Exception ex)
{
try
{
Debug.WriteLine("Exception thrown while trying to get allocation stack: " + ex);
}
catch
{
}
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string message)
{
#if DEBUG
if( !expression )
{
Debug.Fail(message + "\r\nError: " + DbgUtil.GetLastErrorStr());
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2, arg3 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3, object arg4)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2, arg3, arg4 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3, object arg4, object arg5)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2, arg3, arg4, arg5 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")] // This code will be compiled into the assembly anyways, it is up to the compiler to ignore the call.
private static void AssertWin32Impl(bool expression, string format, object[] args)
{
#if DEBUG
if( !expression )
{
string message = string.Format(CultureInfo.CurrentCulture, format, args);
Debug.Fail(message + "\r\nError: " + DbgUtil.GetLastErrorStr());
}
#endif
}
//
// WARNING: Your PInvoke function needs to have the DllImport.SetLastError=true for this method
// to work properly. From the MSDN:
// GetLastWin32Error exposes the Win32 GetLastError API method from Kernel32.DLL. This method exists
// because it is not safe to make a direct platform invoke call to GetLastError to obtain this information.
// If you want to access this error code, you must call GetLastWin32Error rather than writing your own
// platform invoke definition for GetLastError and calling it. The common language runtime can make
// internal calls to APIs that overwrite the operating system maintained GetLastError.
//
// You can only use this method to obtain error codes if you apply the System.Runtime.InteropServices.DllImportAttribute
// to the method signature and set the SetLastError field to true.
//
[SuppressMessage("Microsoft.Interoperability", "CA1404:CallGetLastErrorImmediatelyAfterPInvoke")]
public static string GetLastErrorStr()
{
int MAX_SIZE = 255;
StringBuilder buffer = new StringBuilder(MAX_SIZE);
string message = String.Empty;
int err = 0;
try
{
err = Marshal.GetLastWin32Error();
int retVal = FormatMessage(
FORMAT_MESSAGE_DEFAULT,
new HandleRef(null, IntPtr.Zero),
err,
GetUserDefaultLCID(),
buffer,
MAX_SIZE,
new HandleRef(null, IntPtr.Zero) );
message = retVal != 0 ? buffer.ToString() : "";
}
catch( Exception ex)
{
if( DbgUtil.IsCriticalException(ex) )
{
throw; //rethrow critical exception.
}
message = ex.ToString();
}
return String.Format( CultureInfo.CurrentCulture, "0x{0:x8} - {1}", err, message);
}
///
/// Duplicated here from ClientUtils not to depend on that code because this class is to be
/// compiled into System.Drawing and System.Windows.Forms.
///
private static bool IsCriticalException( Exception ex )
{
return
//ex is NullReferenceException ||
ex is StackOverflowException ||
ex is OutOfMemoryException ||
ex is System.Threading.ThreadAbortException;
}
///
///
public static string StackTrace
{
get
{
return Environment.StackTrace;
}
}
///
/// Returns information about the top stack frames in a string format. The input param determines the number of
/// frames to include.
///
public static string StackFramesToStr( int maxFrameCount )
{
string trace = String.Empty;
try
{
StackTrace st = new StackTrace( true );
int dbgUtilFrameCount = 0;
//
// Ignore frames for methods on this library.
// Note: The stack frame holds the latest frame at index 0.
//
while( dbgUtilFrameCount < st.FrameCount )
{
StackFrame sf = st.GetFrame(dbgUtilFrameCount);
if( sf == null || sf.GetMethod().DeclaringType != typeof(DbgUtil) )
{
break;
}
dbgUtilFrameCount++;
}
maxFrameCount += dbgUtilFrameCount; // add ignored frames.
if( maxFrameCount > st.FrameCount )
{
maxFrameCount = st.FrameCount;
}
for(int i = dbgUtilFrameCount; i < maxFrameCount; i++ )
{
StackFrame sf = st.GetFrame(i);
if( sf == null )
{
continue;
}
MethodBase mi = sf.GetMethod();
if( mi == null )
{
continue;
}
string args = String.Empty;
string fileName = sf.GetFileName();
int backSlashIndex = fileName == null ? -1 : fileName.LastIndexOf( '\\' );
if( backSlashIndex != -1 )
{
fileName = fileName.Substring( backSlashIndex + 1, fileName.Length - backSlashIndex - 1);
}
foreach( ParameterInfo pi in mi.GetParameters() )
{
args += pi.ParameterType.Name + ", ";
}
if( args.Length > 0 ) // remove last comma.
{
args = args.Substring(0, args.Length - 2);
}
trace += String.Format(CultureInfo.CurrentCulture, "at {0}:{1} {2}.{3}({4})\r\n", fileName, sf.GetFileLineNumber(), mi.DeclaringType, mi.Name, args );
}
}
catch( Exception ex )
{
if( DbgUtil.IsCriticalException(ex) )
{
throw; //rethrow critical exception.
}
trace += ex.ToString();
}
return trace.ToString();
}
///
/// Returns information about the top stack frames in a string format.
///
public static string StackFramesToStr()
{
return StackFramesToStr( DbgUtil.gdipInitMaxFrameCount );
}
///
/// Returns information about the top stack frames in a string format. The input param determines the number of
/// frames to include. The 'message' parameter is used as the header of the returned string.
///
public static string StackTraceToStr( string message, int frameCount )
{
return String.Format( CultureInfo.CurrentCulture, "{0}\r\nTop Stack Trace:\r\n{1}", message, DbgUtil.StackFramesToStr(frameCount));
}
///
/// Returns information about the top stack frames in a string format. The 'message' parameter is used as the header of the returned string.
///
public static string StackTraceToStr( string message )
{
return StackTraceToStr(message, DbgUtil.gdipInitMaxFrameCount );
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
// SECREVIEW: This is a debug-only library that won't ship with retail builds.
//
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1801:AvoidUnusedParameters", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.AssertFinalization(System.Object,System.Boolean):System.Void")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.AssertFinalization(System.Object,System.Boolean):System.Void")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA902:MovePInvokesToNativeMethodsClass", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2101:SpecifyMarshalingForPInvokeStringArguments", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.FormatMessage(System.Int32,System.Runtime.InteropServices.HandleRef,System.Int32,System.Int32,System.Text.StringBuilder,System.Int32,System.Runtime.InteropServices.HandleRef):System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA902:MovePInvokesToNativeMethodsClass", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2205:UseManagedEquivalentsOfWin32Api", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetUserDefaultLCID():System.Int32")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2106:SecureAsserts", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.IsCriticalException(System.Exception):System.Boolean")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.StackFramesToStr(System.Int32):System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1818:DoNotConcatenateStringsInsideLoops", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.StackFramesToStr(System.Int32):System.String")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Interoperability", "CA1404:CallGetLastErrorImmediatelyAfterPInvoke", Scope="member", Target="System.Windows.Forms.Internal.DbgUtil.GetLastErrorStr():System.String")]
#if WINFORMS_NAMESPACE
namespace System.Windows.Forms.Internal
#elif DRAWING_NAMESPACE
namespace System.Drawing.Internal
#else
namespace System.Internal
#endif
{
using System;
using System.Drawing;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
using System.Text;
using System.Runtime.InteropServices;
using System.Security.Permissions;
using System.Globalization;
///
/// Debug help utility.
///
[
ReflectionPermission(SecurityAction.Assert, TypeInformation=true, MemberAccess=true),
EnvironmentPermission(SecurityAction.Assert, Unrestricted=true),
FileIOPermission(SecurityAction.Assert, Unrestricted=true),
SecurityPermission(SecurityAction.Assert, Flags=SecurityPermissionFlag.UnmanagedCode),
UIPermission(SecurityAction.Assert, Unrestricted=true)
]
internal sealed class DbgUtil
{
public const int
FORMAT_MESSAGE_ALLOCATE_BUFFER = 0x00000100,
FORMAT_MESSAGE_IGNORE_INSERTS = 0x00000200,
FORMAT_MESSAGE_FROM_SYSTEM = 0x00001000,
FORMAT_MESSAGE_DEFAULT = FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_FROM_SYSTEM;
[DllImport(ExternDll.Kernel32, SetLastError=true, CharSet=System.Runtime.InteropServices.CharSet.Auto)]
public static extern int GetUserDefaultLCID();
[DllImport(ExternDll.Kernel32, SetLastError=true, CharSet=System.Runtime.InteropServices.CharSet.Auto)]
public static extern int FormatMessage(int dwFlags, HandleRef lpSource, int dwMessageId, int dwLanguageId, StringBuilder lpBuffer, int nSize, HandleRef arguments);
public static int gdipInitMaxFrameCount = 8;
public static int gdiUseMaxFrameCount = 8;
public static int finalizeMaxFrameCount = 5;
// Methods
///
/// Call this method from your Dispose(bool) to assert that unmanaged resources has been explicitly disposed.
///
[Conditional("DEBUG")] // This code will be compiled into the assembly anyways, it is up to the compiler to ignore the call.
public static void AssertFinalization(object obj, bool disposing)
{
#if GDI_FINALIZATION_WATCH
if( disposing || AppDomain.CurrentDomain.IsFinalizingForUnload() )
{
return;
}
try
{
BindingFlags bindingFlags = BindingFlags.NonPublic | BindingFlags.GetField | BindingFlags.Static | BindingFlags.Instance;
FieldInfo allocSiteFld = obj.GetType().GetField("AllocationSite", bindingFlags);
string allocationSite = allocSiteFld != null ? allocSiteFld.GetValue( obj ).ToString() : "";
// ignore ojects created by WindowsGraphicsCacheManager.
if( allocationSite.Contains("WindowsGraphicsCacheManager") )
{
return;
}
Debug.Fail("Object Disposed through finalization - it should be explicitly disposed.");
Debug.WriteLine("Allocation stack:\r\n" + allocationSite);
}
catch(Exception ex)
{
try
{
Debug.WriteLine("Exception thrown while trying to get allocation stack: " + ex);
}
catch
{
}
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string message)
{
#if DEBUG
if( !expression )
{
Debug.Fail(message + "\r\nError: " + DbgUtil.GetLastErrorStr());
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2, arg3 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3, object arg4)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2, arg3, arg4 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")]
public static void AssertWin32(bool expression, string format, object arg1, object arg2, object arg3, object arg4, object arg5)
{
#if DEBUG
if( !expression )
{
object[] args = new object[]{ arg1, arg2, arg3, arg4, arg5 };
AssertWin32Impl( expression, format, args );
}
#endif
}
///
///
[Conditional("DEBUG")] // This code will be compiled into the assembly anyways, it is up to the compiler to ignore the call.
private static void AssertWin32Impl(bool expression, string format, object[] args)
{
#if DEBUG
if( !expression )
{
string message = string.Format(CultureInfo.CurrentCulture, format, args);
Debug.Fail(message + "\r\nError: " + DbgUtil.GetLastErrorStr());
}
#endif
}
//
// WARNING: Your PInvoke function needs to have the DllImport.SetLastError=true for this method
// to work properly. From the MSDN:
// GetLastWin32Error exposes the Win32 GetLastError API method from Kernel32.DLL. This method exists
// because it is not safe to make a direct platform invoke call to GetLastError to obtain this information.
// If you want to access this error code, you must call GetLastWin32Error rather than writing your own
// platform invoke definition for GetLastError and calling it. The common language runtime can make
// internal calls to APIs that overwrite the operating system maintained GetLastError.
//
// You can only use this method to obtain error codes if you apply the System.Runtime.InteropServices.DllImportAttribute
// to the method signature and set the SetLastError field to true.
//
[SuppressMessage("Microsoft.Interoperability", "CA1404:CallGetLastErrorImmediatelyAfterPInvoke")]
public static string GetLastErrorStr()
{
int MAX_SIZE = 255;
StringBuilder buffer = new StringBuilder(MAX_SIZE);
string message = String.Empty;
int err = 0;
try
{
err = Marshal.GetLastWin32Error();
int retVal = FormatMessage(
FORMAT_MESSAGE_DEFAULT,
new HandleRef(null, IntPtr.Zero),
err,
GetUserDefaultLCID(),
buffer,
MAX_SIZE,
new HandleRef(null, IntPtr.Zero) );
message = retVal != 0 ? buffer.ToString() : "";
}
catch( Exception ex)
{
if( DbgUtil.IsCriticalException(ex) )
{
throw; //rethrow critical exception.
}
message = ex.ToString();
}
return String.Format( CultureInfo.CurrentCulture, "0x{0:x8} - {1}", err, message);
}
///
/// Duplicated here from ClientUtils not to depend on that code because this class is to be
/// compiled into System.Drawing and System.Windows.Forms.
///
private static bool IsCriticalException( Exception ex )
{
return
//ex is NullReferenceException ||
ex is StackOverflowException ||
ex is OutOfMemoryException ||
ex is System.Threading.ThreadAbortException;
}
///
///
public static string StackTrace
{
get
{
return Environment.StackTrace;
}
}
///
/// Returns information about the top stack frames in a string format. The input param determines the number of
/// frames to include.
///
public static string StackFramesToStr( int maxFrameCount )
{
string trace = String.Empty;
try
{
StackTrace st = new StackTrace( true );
int dbgUtilFrameCount = 0;
//
// Ignore frames for methods on this library.
// Note: The stack frame holds the latest frame at index 0.
//
while( dbgUtilFrameCount < st.FrameCount )
{
StackFrame sf = st.GetFrame(dbgUtilFrameCount);
if( sf == null || sf.GetMethod().DeclaringType != typeof(DbgUtil) )
{
break;
}
dbgUtilFrameCount++;
}
maxFrameCount += dbgUtilFrameCount; // add ignored frames.
if( maxFrameCount > st.FrameCount )
{
maxFrameCount = st.FrameCount;
}
for(int i = dbgUtilFrameCount; i < maxFrameCount; i++ )
{
StackFrame sf = st.GetFrame(i);
if( sf == null )
{
continue;
}
MethodBase mi = sf.GetMethod();
if( mi == null )
{
continue;
}
string args = String.Empty;
string fileName = sf.GetFileName();
int backSlashIndex = fileName == null ? -1 : fileName.LastIndexOf( '\\' );
if( backSlashIndex != -1 )
{
fileName = fileName.Substring( backSlashIndex + 1, fileName.Length - backSlashIndex - 1);
}
foreach( ParameterInfo pi in mi.GetParameters() )
{
args += pi.ParameterType.Name + ", ";
}
if( args.Length > 0 ) // remove last comma.
{
args = args.Substring(0, args.Length - 2);
}
trace += String.Format(CultureInfo.CurrentCulture, "at {0}:{1} {2}.{3}({4})\r\n", fileName, sf.GetFileLineNumber(), mi.DeclaringType, mi.Name, args );
}
}
catch( Exception ex )
{
if( DbgUtil.IsCriticalException(ex) )
{
throw; //rethrow critical exception.
}
trace += ex.ToString();
}
return trace.ToString();
}
///
/// Returns information about the top stack frames in a string format.
///
public static string StackFramesToStr()
{
return StackFramesToStr( DbgUtil.gdipInitMaxFrameCount );
}
///
/// Returns information about the top stack frames in a string format. The input param determines the number of
/// frames to include. The 'message' parameter is used as the header of the returned string.
///
public static string StackTraceToStr( string message, int frameCount )
{
return String.Format( CultureInfo.CurrentCulture, "{0}\r\nTop Stack Trace:\r\n{1}", message, DbgUtil.StackFramesToStr(frameCount));
}
///
/// Returns information about the top stack frames in a string format. The 'message' parameter is used as the header of the returned string.
///
public static string StackTraceToStr( string message )
{
return StackTraceToStr(message, DbgUtil.gdipInitMaxFrameCount );
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- QueryableDataSource.cs
- EventManager.cs
- TransformerConfigurationWizardBase.cs
- AnimatedTypeHelpers.cs
- TextDecorationCollection.cs
- Matrix3D.cs
- RotateTransform.cs
- TagPrefixAttribute.cs
- MembershipPasswordException.cs
- DiagnosticsConfiguration.cs
- DataKey.cs
- PermissionToken.cs
- RegexMatch.cs
- ListViewUpdateEventArgs.cs
- CompilerScope.cs
- SymmetricKeyWrap.cs
- WebPartConnectionCollection.cs
- ISAPIRuntime.cs
- DataColumnMapping.cs
- TerminateSequenceResponse.cs
- TickBar.cs
- Nullable.cs
- DateTimeUtil.cs
- ContainerActivationHelper.cs
- TextOutput.cs
- FreezableDefaultValueFactory.cs
- SourceSwitch.cs
- AnnotationMap.cs
- ToolStripTextBox.cs
- MemberMaps.cs
- SpStreamWrapper.cs
- FormatConvertedBitmap.cs
- EdmRelationshipRoleAttribute.cs
- XmlHierarchicalEnumerable.cs
- ToolStripScrollButton.cs
- Brushes.cs
- FileLevelControlBuilderAttribute.cs
- SystemParameters.cs
- ElementUtil.cs
- AdapterDictionary.cs
- IndentedWriter.cs
- MembershipSection.cs
- EventMappingSettings.cs
- TemplateControlBuildProvider.cs
- MethodCallTranslator.cs
- Baml2006KnownTypes.cs
- HttpListenerRequestUriBuilder.cs
- SmtpLoginAuthenticationModule.cs
- Block.cs
- SmiEventSink.cs
- HtmlGenericControl.cs
- RadioButtonAutomationPeer.cs
- RelatedCurrencyManager.cs
- GridViewUpdatedEventArgs.cs
- WizardForm.cs
- WorkflowInstanceExtensionCollection.cs
- MobileRedirect.cs
- DataGridViewColumnDesigner.cs
- ScrollChrome.cs
- ComponentChangingEvent.cs
- SystemIPGlobalProperties.cs
- IPEndPointCollection.cs
- CollectionBase.cs
- AutomationProperties.cs
- CodeTypeConstructor.cs
- ScriptModule.cs
- ContextItem.cs
- ListViewVirtualItemsSelectionRangeChangedEvent.cs
- SqlInternalConnectionSmi.cs
- DateTimeParse.cs
- BufferBuilder.cs
- EnvelopedPkcs7.cs
- RelationshipConverter.cs
- DataGridViewAdvancedBorderStyle.cs
- ComponentResourceManager.cs
- SoapSchemaExporter.cs
- LinkDesigner.cs
- TextPattern.cs
- Proxy.cs
- DifferencingCollection.cs
- QueryGeneratorBase.cs
- TraceData.cs
- ClassHandlersStore.cs
- GeometryCollection.cs
- IApplicationTrustManager.cs
- SafeNativeMethods.cs
- EventRoute.cs
- Rotation3D.cs
- ConfigurationSectionCollection.cs
- DockingAttribute.cs
- RenamedEventArgs.cs
- SafeRegistryKey.cs
- WebDescriptionAttribute.cs
- ListDictionary.cs
- ApplicationDirectoryMembershipCondition.cs
- Processor.cs
- AutomationPatternInfo.cs
- Point4DValueSerializer.cs
- DataKeyArray.cs
- ContractSearchPattern.cs