MarkProfile

[アーティクル]
02/21/2013

MarkProfile メソッドは、.vsp ファイルにプロファイルマークを挿入します。MarkProfile 関数を含むスレッドのプロファイル実行は、挿入されるマークについてオンにしておく必要があります。

PROFILE_COMMAND_STATUS PROFILERAPI MarkProfile( long lMarker );

パラメーター

lMarker

挿入するマーカー。マーカーは 0 以上の値にする必要があります。

プロパティ値/戻り値

関数の成功または失敗は、PROFILE_COMMAND_STATUS 列挙型を使って表されます。戻り値は次のいずれかになります。

列挙子	Description
MARK_ERROR_MARKER_RESERVED	パラメーターは 0 以下です。これらの値は予約済みです。マークとコメントは記録されません。
MARK_ERROR_MODE_NEVER	関数が呼び出されたときに、プロファイルモードが NEVER に設定されました。マークとコメントは記録されません。
MARK_ERROR_MODE_OFF	関数が呼び出されたときに、プロファイルモードが OFF に設定されました。マークとコメントは記録されません。
MARK_ERROR_NO_SUPPORT	このコンテキストでマークがサポートされていません。マークとコメントは記録されません。
MARK_ERROR_OUTOFMEMORY	メモリ不足のため、このイベントを記録できません。マークとコメントは記録されません。
MARK_TEXTTOOLONG	文字列の長さが最大値の 256 文字を超えています。コメント文字列は切り詰められ、マークとコメントが記録されます。
MARK_OK	成功した場合は MARK_OK が返されます。

解説

MarkProfile 関数を含むスレッドにプロファイルが実行される場合、コードが実行されるたびに .vsp ファイルにマーク値が挿入されます。MarkProfile は複数回呼び出すことができます。

プロファイルマークは、スコープ内でグローバルです。たとえば、あるスレッドに挿入したプロファイルマークを、.vsp ファイル内の任意のスレッドで使用し、データセグメントの開始または終了をマークできます。

Mark コマンドまたは API 関数 (CommentMarkAtProfile、CommentMarkProfile、または MarkProfile) でマークとコメントが挿入されたとき、マークのプロファイル関数を含むスレッドでは、プロファイル状態をオンにする必要があります。

重要
MarkProfile メソッドは、インストルメンテーションプロファイリングでのみ使用してください。

同等の .NET Framework 関数

Microsoft.VisualStudio.Profiler.dll

関数の情報

ヘッダー : VSPerf.h で宣言

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

使用例

次のコードは、MarkProfile 関数の使用例を示しています。

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
}

参照

その他の技術情報

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

次の方法で共有