Share via

SuspendProfile (Windows Embedded CE 6.0)

  • Article

1/5/2010

This function increments the suspend/resume counter for the specified profiling level.

int SuspendProfile(
    int nLevel,
    DWORD dwID
);

Parameters

  • nLevel
    Level of execution of the identifier specified in the dwID parameter.

    The following table shows possible values for the nLevel parameter.

    Value Description

    PROFILE_GLOBALLEVEL

    Global level settings affect all processes and threads in the profiling run.

    PROFILE_PROCESSLEVEL

    Process level settings affect all threads that are part of the process specified by the dwId parameter.

    PROFILE_THREADLEVEL

    Thread profiling level settings affect the thread specified by the dwId parameter.

  • dwID
    Element to which the function applies.

    For a global-level element, use only the PROFILE_CURRENTID value.

    To specify a current process or thread, use PROFILE_CURRENTID value.

    To specify a process or thread other than the current process or thread, use the identifier for the process or thread generated by the system.

Return Values

The following table shows the values that this function returns.

Value Description

PROFILE_OK

The call was successful.

PROFILE_ERROR_NOT_YET_IMPLEMENTED

The profiling function call, profiling level, or combination of call and level is not implemented.

PROFILE_ERROR_MODE_NEVER

The profiling mode was set to NEVER when the function was called.

PROFILE_ERROR_LEVEL_NO_EXIST

The profiling level specified by the nLevelparameter does not exist.

PROFILE_ERROR_ID_NO_EXIST

The profiling element specified by the dwId parameter does not exist.

Remarks

The SuspendProfile function and the ResumeProfile function control the suspend/resume counter for the profiling level. The suspend/resume counter is typically used to override the standard Remote Call Profiler API data control functions.

The initial value of the suspend/resume counter is 0 (zero).

Each call to the ResumeProfile function subtracts 1 from the suspend/resume count.

When the suspend/resume count is greater than 0 (zero), the suspend/resume state for the level is OFF.

When the count is less than or equal to 0 (zero), 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 be ON.

Requirements

Header cecap.h
Library cecap.lib
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Concepts

Call Profiler Data Collection Functions
ResumeProfile
Call Profiler Collection Control Window
Call Profiler Data Collection API Reference
Data Collection Control