DataCollection.SuspendProfile メソッド

更新 : 2007 年 11 月

SuspendProfile メソッドは、指定されたプロファイルレベルの保留/再開カウンタをインクリメントします。

名前空間 : Microsoft.VisualStudio.Profiler
アセンブリ : Microsoft.VisualStudio.Profiler (Microsoft.VisualStudio.Profiler.dll 内)

構文

'宣言
Public Shared Function SuspendProfile ( _
    profileLevel As ProfileLevel, _
    elementId As UInteger _
) As ProfileOperationResult
'使用
Dim profileLevel As ProfileLevel
Dim elementId As UInteger
Dim returnValue As ProfileOperationResult

returnValue = DataCollection.SuspendProfile(profileLevel, _
    elementId)

public static ProfileOperationResult SuspendProfile(
    ProfileLevel profileLevel,
    uint elementId
)

public:
static ProfileOperationResult SuspendProfile(
    ProfileLevel profileLevel, 
    unsigned int elementId
)

public static function SuspendProfile(
    profileLevel : ProfileLevel, 
    elementId : uint
) : ProfileOperationResult

パラメータ

profileLevel
型 : Microsoft.VisualStudio.Profiler.ProfileLevel

elementId で指定されている ID の実行レベルを指定します。

elementId
型 : System.UInt32

システムによって生成される、プロセスまたはスレッドの ID。

戻り値

型 : Microsoft.VisualStudio.Profiler.ProfileOperationResult

戻り値の ProfileOperationResult は列挙型です。

解説

SuspendProfile および ResumeProfile によって、プロファイルレベルにおける保留/再開カウンタを制御します。通常、保留/再開カウンタはプロファイラ API の標準のデータ制御関数をオーバーライドするために使用されます。

保留/再開カウンタの初期値は 0 です。SuspendProfile を呼び出すたびに、保留/再開数に 1 が加算されます。ResumeProfile を呼び出すたびに、1 が減算されます。

保留/再開数が 0 よりも大きい場合、そのレベルの保留/再開状態はオフになります。保留/再開数が 0 以下の場合、保留/再開状態はオンになります。

開始/停止状態と保留/再開状態の両方がオンの場合、そのレベルのプロファイル状態はオンです。プロファイルの対象となるスレッドでは、グローバルレベル状態、プロセスレベル状態、スレッドレベル状態がすべてオンである必要があります。

例

次に SuspendProfile メソッドの例を示します。この例では、DataCollection.CurrentId プロパティで識別されるプロセスまたはスレッドに対し、StartProfile が既に呼び出されていることを前提としています。

        public 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. 
                        
            // Declare enumeration to hold result of call 
            // to SuspendProfile
            ProfileOperationResult profileResult;

            profileResult = DataCollection.SuspendProfile(
                ProfileLevel.Global,
                DataCollection.CurrentId);

            Console.WriteLine("SuspendProfile returned {0}", profileResult);
         }