MaxSDK::Util::DebugHelpers Namespace Reference

Classes
struct	THREADNAME_INFO

Functions
void	SetThreadName (DWORD dwThreadID, LPCSTR pcszThreadName)
	Sets the name of the given thread. More...
void	SetThreadName (LPCSTR pcszThreadName)
	Sets the name of the current thread. More...
void	SetThreadNameDebug (DWORD dwThreadID, LPCSTR pcszThreadName)
	Sets the name of the given thread. More...
void	SetThreadNameDebug (LPCSTR pcszThreadName)
	Sets the name of the current thread, but only if building for debug. More...
void	Trace (LPCMSTR lpctszMsg,...)
	Send a string to the debugger's output window, but only in debug builds. More...
void	Trace0 (LPCMSTR lpctszMsg)
	Identical to Trace(), but without the variable argument list. More...

Function Documentation

SetThreadName() [1/2]

void SetThreadName ( DWORD  dwThreadID, LPCSTR  pcszThreadName  )

inline

Sets the name of the given thread.

The given name will appear in the thread view of the debugger, enabling easier debugging.

Parameters

dwThreadID	The ID of the thread for which to set the name.
pcszThreadName	The string to use as the name of the thread.

{
    THREADNAME_INFO info(pcszThreadName, dwThreadID);
 
    enum { MS_VC_EXCEPTION_ID = 0x406D1388 };
#ifdef _MSC_VER
    __try
#endif
    {
        RaiseException( MS_VC_EXCEPTION_ID, 0, 
            sizeof(info)/ sizeof(ULONG_PTR), 
            reinterpret_cast<const ULONG_PTR*>(&info) );
    }
#ifdef _MSC_VER
    __except (EXCEPTION_CONTINUE_EXECUTION)
    {
        // empty
    }
#endif
}

SetThreadName() [2/2]

void SetThreadName ( LPCSTR  pcszThreadName )

inline

Sets the name of the current thread.

The given name will appear in the thread view of the debugger, enabling easier debugging.

Parameters

pcszThreadName

The string to use as the name of the thread.

{
#if (_MANAGED == 1) || (_M_CEE == 1)
    DebugHelpersCLR::SetThreadName(pcszThreadName);
#else
    SetThreadName((DWORD)-1, pcszThreadName);
#endif
}

SetThreadNameDebug() [1/2]

void SetThreadNameDebug ( DWORD  dwThreadID, LPCSTR  pcszThreadName  )

inline

Sets the name of the given thread.

The given name will appear in the thread view of the debugger, enabling easier debugging. If the thread name shouldn't appear in release builds (e.g. because of security risks), then use this method instead of SetThreadName().

Parameters

dwThreadID	The ID of the thread for which to set the name.
pcszThreadName	The string to use as the name of the thread.

{
#ifdef _DEBUG
    SetThreadName(dwThreadID, pcszThreadName);
#else
    UNUSED_PARAM(dwThreadID);
    UNUSED_PARAM(pcszThreadName);
#endif
}

SetThreadNameDebug() [2/2]

void SetThreadNameDebug ( LPCSTR  pcszThreadName )

inline

Sets the name of the current thread, but only if building for debug.

The given name will appear in the thread view of the debugger, enabling easier debugging. If the thread name shouldn't appear in release builds (e.g. because of security risks), then use this method instead of SetThreadName().

Parameters

pcszThreadName

The string to use as the name of the thread.

{
#ifdef _DEBUG
 
#if (_MANAGED == 1) || (_M_CEE == 1)
    MaxSDK::Util::DebugHelpersCLR::SetThreadName(pcszThreadName);
#else
    SetThreadName((DWORD)-1, pcszThreadName);
#endif
 
#else
    UNUSED_PARAM(pcszThreadName);
#endif
}

Trace()

void Trace ( LPCMSTR  lpctszMsg,   ...  )

inline

Send a string to the debugger's output window, but only in debug builds.

More convenient than having to #ifndef NDEBUG all over the place. It also supports a variable number of arguments, as you can see.

Parameters

lpctszMsg

The string to send to the debugger's output window.

{
#ifndef NDEBUG
    MCHAR tszBuffer[4096];
 
    va_list args;
    va_start(args, lpctszMsg);
 
    _vsntprintf_s(tszBuffer, 4096, lpctszMsg, args);
    DebugOutputString(tszBuffer);
 
    va_end(args);
#else
    UNUSED_PARAM(lpctszMsg);
#endif
}

Trace0()

void Trace0 ( LPCMSTR  lpctszMsg )

inline

Identical to Trace(), but without the variable argument list.

{
#ifndef NDEBUG
    DebugOutputString(lpctszMsg);
#else
    UNUSED_PARAM(lpctszMsg);
#endif
}