SuspendProfile

Article
04/28/2015

The SuspendProfile method increments the Suspend/Resume counter for the specified profiling level.

PROFILE_COMMAND_STATUS PROFILERAPI SuspendProfile(
                       PROFILE_CONTROL_LEVEL Level, 
                       unsigned int dwId);

Parameters

Level

Indicates the profile level to which performance data collection can be applied. The following PROFILE_CONTROL_LEVEL enumerators can be used to indicate one of the three levels to which performance data collection can be applied:

Enumerator	Description
PROFILE_GLOBALLEVEL	Global level setting affects all processes and threads in the profiling run.
PROFILE_PROCESSLEVEL	Process level setting affect all threads that are part of specified process.
PROFILE_THREADLEVEL	Thread profiling Level setting affects the specified thread.

dwId

The process or thread identifier generated by the system.

Property Value/Return Value

The function indicates success or failure by using PROFILE_COMMAND_STATUS enumeration. The return value can be one of the following:

Enumerator	Description
PROFILE_ERROR_ID_NOEXIST	The profiling element ID does not exist.
PROFILE_ERROR_LEVEL_NOEXIST	The profiling level specified does not exist.
PROFILE_ERROR_MODE_NEVER	The profiling mode was set to NEVER when the function was called.
PROFILE_ERROR_NOT_YET_IMPLEMENTED	The profiling function call, profiling level, or combination of call and level is not yet implemented.
PROFILE_OK	The call was successful.

Remarks

The initial value of the Suspend/Resume counter is 0. Each call to SuspendProfile adds 1 to the Suspend/Resume count; each call to ResumeProfile subtracts 1.

When the Suspend/Resume count is greater than 0, the Suspend/Resume state for the level is OFF. When the count is less than or equal to 0, the Suspend/Resume state is ON.

When the Start/Stop state and the Suspend/Resume state are both ON, the profiling state for the level is ON. For a thread to be profiled, the global, process, and thread level states for the thread must all be ON.

.NET Framework Equivalent

Microsoft.VisualStudio.Profiler.dll

Function Information

Header: Declared in VSPerf.h

Import library: VSPerf.lib

Example

The following example illustrates the SuspendProfile method. This example assumes that a prior call to StartProfile has been made for the process or thread identified by PROFILE_CURRENTID.

void ExerciseSuspendProfile()
{
    // The initial value of the Suspend/Resume counter is 0.
    // Each call to SuspendProfile adds 1 to the
    // Suspend/Resume count; each call
    // to ResumeProfile subtracts 1.
            
    // Variables used to print output
    HRESULT hResult;
    TCHAR tchBuffer[256];

    // Declare enumeration to hold result of call
    // to SuspendProfile
    PROFILE_COMMAND_STATUS profileResult;

    profileResult = SuspendProfile(
        PROFILE_GLOBALLEVEL,
        PROFILE_CURRENTID);

    // Format and print result.
    LPCTSTR pszFormat = TEXT("%s %d.\0");
    TCHAR* pszTxt = TEXT("SuspendProfile returned");
    hResult = StringCchPrintf(tchBuffer, 256, pszFormat, 
        pszTxt, profileResult);

#ifdef DEBUG
    OutputDebugString(tchBuffer);
#endif
}

Share via