MarkProfileMarkProfile

MarkProfile メソッドは、.vsp ファイルにプロファイル マークを挿入します。The MarkProfile method inserts a profile mark in the .vsp file. MarkProfile 関数を含むスレッドのプロファイル実行は、挿入されるマークについてオンにしておく必要があります。Profiling for the thread containing the MarkProfile function must be ON for the mark to be inserted.

構文Syntax

PROFILE_COMMAND_STATUS PROFILERAPI MarkProfile( long lMarker );  

パラメーターParameters

lMarker

挿入するマーカー。The marker to insert. マーカーは 0 以上の値にする必要があります。The marker must be greater than or equal to 0 (zero).

プロパティ値/戻り値Property Value/Return Value

関数の成功または失敗は、PROFILE_COMMAND_STATUS 列挙型を使って表されます。The function indicates success or failure by using PROFILE_COMMAND_STATUS enumeration. 戻り値は次のいずれかになります。The return value can be one of the following:

列挙子Enumerator 説明Description
MARK_ERROR_MARKER_RESERVEDMARK_ERROR_MARKER_RESERVED パラメーターは 0 以下です。The parameter is less than or equal to 0. これらの値は予約済みです。These values are reserved. マークとコメントは記録されません。The mark and comment are not recorded.
MARK_ERROR_MODE_NEVERMARK_ERROR_MODE_NEVER 関数が呼び出されたときに、プロファイル モードが NEVER に設定されました。The profiling mode was set to NEVER when the function was called. マークとコメントは記録されません。The mark and comment are not recorded.
MARK_ERROR_MODE_OFFMARK_ERROR_MODE_OFF 関数が呼び出されたときに、プロファイル モードが OFF に設定されました。The profiling mode was set to OFF when the function was called. マークとコメントは記録されません。The mark and comment are not recorded.
MARK_ERROR_NO_SUPPORTMARK_ERROR_NO_SUPPORT このコンテキストでマークがサポートされていません。No mark support in this context. マークとコメントは記録されません。The mark and comment are not recorded.
MARK_ERROR_OUTOFMEMORYMARK_ERROR_OUTOFMEMORY メモリ不足のため、このイベントを記録できません。Memory was not available to record the event. マークとコメントは記録されません。The mark and comment are not recorded.
MARK_TEXTTOOLONGMARK_TEXTTOOLONG 文字列の長さが最大値の 256 文字を超えています。The string exceeds the maximum of 256 characters. コメント文字列は切り詰められ、マークとコメントが記録されます。The comment string is truncated and the mark and comment are recorded.
MARK_OKMARK_OK 成功した場合は MARK_OK が返されます。MARK_OK is returned to indicate success.

コメントRemarks

MarkProfile 関数を含むスレッドにプロファイルが実行される場合、コードが実行されるたびに .vsp ファイルにマーク値が挿入されます。The mark value is inserted into the .vsp file each time the code runs if the thread containing the MarkProfile function is being profiled. MarkProfile は複数回呼び出すことができます。You can call MarkProfile multiple times.

プロファイル マークは、スコープ内でグローバルです。Profile marks are global in scope. たとえば、あるスレッドに挿入したプロファイルマークを、.vsp ファイル内の任意のスレッドで使用し、データ セグメントの開始または終了をマークできます。For example, a profile mark inserted in one thread can be used to mark the start or end of a data segment in any thread in the .vsp file.

Mark コマンドまたは API 関数 (CommentMarkAtProfile、CommentMarkProfile、または MarkProfile) でマークとコメントが挿入されたとき、マークのプロファイル関数を含むスレッドでは、プロファイル状態をオンにする必要があります。The profiling state for the thread that contains the mark profile function must be on when marks and comments inserted with the Mark command or with API functions (CommentMarkAtProfile, CommentMarkProfile, or MarkProfile).

重要

MarkProfile メソッドは、インストルメンテーション プロファイリングでのみ使用してください。MarkProfile method should be used with instrumentation profiling only.

同等の .NET Framework 関数.NET Framework Equivalent

Microsoft.VisualStudio.Profiler.dllMicrosoft.VisualStudio.Profiler.dll

関数の情報Function Information

ヘッダー : VSPerf.h で宣言Header: Declared in VSPerf.h

インポート ライブラリ : VSPerf.libImport library: VSPerf.lib

Example

次のコードは、MarkProfile 関数の使用例を示しています。The following code illustrates the MarkProfile function.

void ExerciseMarkProfile()  
{  
    // Declare and initialize variables to pass to   
    // MarkProfile.  The values of these parameters   
    // are assigned based on the needs of the code;  
    // and for the sake of simplicity in this example,   
    // the variables are assigned arbitrary values.  
    int markId = 03;  

    // Declare enumeration to hold return value of   
    // call to MarkProfile.  
    PROFILE_COMMAND_STATUS markResult;  

    // Variables used to print output.  
    HRESULT hResult;  
    TCHAR tchBuffer[256];  

    markResult = MarkProfile(markId);  

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

#ifdef DEBUG  
    OutputDebugString(tchBuffer);  
#endif  
}  

関連項目See Also

Visual Studio プロファイラー API リファレンス (ネイティブ)Visual Studio Profiler API Reference (Native)