StopProfile
StopProfile 関数は、指定されたプロファイル レベルのカウンターを 0 (オフ) に設定します。
PROFILE_COMMAND_STATUS PROFILERAPI StopProfile(
PROFILE_CONTROL_LEVEL Level,
unsigned int dwId);
パラメーター
Level
パフォーマンス データ収集を適用できるプロファイル レベルを指定します。パフォーマンス データ収集を適用できるレベルには 3 つあり、PROFILE_CONTROL_LEVEL 列挙子を使って指定できます。次のレベルのいずれかを指定できます。
列挙子 |
Description |
|---|---|
PROFILE_GLOBALLEVEL |
グローバル レベル設定は、プロファイル実行のすべてのプロセスとスレッドに影響します。 |
PROFILE_PROCESSLEVEL |
プロセス レベル設定は、指定されたプロセスに含まれるすべてのスレッドに影響します。 |
PROFILE_THREADLEVEL |
スレッド プロファイル レベル設定は、指定されたスレッドに影響します。 |
dwId
システムによって生成される、プロセスまたはスレッドの ID。
プロパティ値/戻り値
関数の成功または失敗は、PROFILE_COMMAND_STATUS 列挙型を使って表されます。戻り値は次のいずれかになります。
列挙子 |
Description |
|---|---|
PROFILE_ERROR_ID_NOEXIST |
プロファイル要素 ID が存在しません。 |
PROFILE_ERROR_LEVEL_NOEXIST |
指定されたプロファイル レベルが存在しません。 |
PROFILE_ERROR_MODE_NEVER |
関数が呼び出されたときに、プロファイル モードが NEVER に設定されました。 |
PROFILE_ERROR_NOT_YET_IMPLEMENTED |
プロファイル関数呼び出し、プロファイル レベル、または呼び出しとレベルの組み合わせがまだ実装されていません。 |
PROFILE_OK |
呼び出しに成功しました。 |
解説
StartProfile および StopProfile によって、プロファイル レベルにおける開始/停止状態を制御します。開始/停止の既定値は 1 です。初期値はレジストリで変更できます。StartProfile を呼び出すたびに、停止/開始が 1 に設定されます。StopProfile を呼び出すたびに、停止/開始が 0 に設定されます。
停止/開始が 0 よりも大きい場合、そのレベルの停止/開始状態はオンになります。停止/開始が 0 以下の場合、停止/開始状態はオフになります。
開始/停止状態と保留/再開状態の両方がオンの場合、そのレベルのプロファイル状態はオンです。プロファイルの対象となるスレッドでは、グローバル レベル状態、プロセス レベル状態、スレッド レベル状態がオンである必要があります。
同等の .NET Framework 関数
Microsoft.VisualStudio.Profiler.dll
関数の情報
ヘッダー : VSPerf.h で宣言
インポート ライブラリ : VSPerf.lib
使用例
次に StopProfile メソッドの例を示します。この例は、PROFILE_CURRENTID で識別される同じスレッドまたはプロセスに対して、StartProfile メソッドが既に呼び出されていることを前提としています。
void ExerciseStopProfile()
{
// StartProfile and StopProfile control the
// Start/Stop state for the profiling level.
// The default initial value of Start/Stop is 1.
// The initial value can be changed in the registry.
// Each call to StartProfile sets Start/Stop to 1;
// each call to StopProfile sets it to 0.
// Variables used to print output.
HRESULT hResult;
TCHAR tchBuffer[256];
// Declare enumeration to hold result of call
// to StopProfile.
PROFILE_COMMAND_STATUS profileResult;
profileResult = StopProfile(
PROFILE_THREADLEVEL,
PROFILE_CURRENTID);
// Format and print result.
LPCTSTR pszFormat = TEXT("%s %d.\0");
TCHAR* pszTxt = TEXT("StopProfile returned");
hResult = StringCchPrintf(tchBuffer, 256, pszFormat,
pszTxt, profileResult);
#ifdef DEBUG
OutputDebugString(tchBuffer);
#endif
}