CommentMarkProfile

Článek
06/08/2015

Funkce CommentMarkProfile vkládá číselnou značku a textový řetězec do souboru .vsp.Pro správné vložení značky a komentáře může být zapnuto profilování vlákna, které funkci CommentMarkProfile obsahuje..

PROFILE_COMMAND_STATUS PROFILERAPI CommentMarkProfile(
                                   long lMarker, 
                                   LPCTSTR szComment);

Parametry

lMarker

Vkládaná číselná značka.Značka musí být větší nebo rovna 0 (nule).

szComment

Ukazatel na vkládaný textový řetězec.Řetězec musí být menší než 256 znaků včetně ukončovacího znaku NULL.

Hodnota/Návratová hodnota vlastnosti

Funkce označuje úspěch nebo neúspěch pomocí výčtu PROFILE_COMMAND_STATUS.Návratová hodnota může být jedna z následujících:

Výčet	Description
MARK_ERROR_MARKER_RESERVED	Parametr je menší nebo roven 0.Tyto hodnoty jsou vyhrazeny.Značka a komentáře nejsou zaznamenávány.
MARK_ERROR_MODE_NEVER	Profilovací režim byl nastaven na hodnotu NEVER, když byla funkce volána.Značka a komentáře nejsou zaznamenávány.
MARK_ERROR_MODE_OFF	Režimu profilování byl v době volání funkce nastaven na vypnutý.Značka a komentáře nejsou zaznamenávány.
MARK_ERROR_NO_SUPPORT	V tomto kontextu neexistuje podpora značek.Značka a komentáře nejsou zaznamenávány.
MARK_ERROR_OUTOFMEMORY	Paměť nebyla pro záznam události dostupná.Značka a komentáře nejsou zaznamenávány.
MARK_TEXTTOOLONG	Řetězec přesahuje maximální délku 256 znaků.Řetězec komentáře je zkrácen a značka a komentář jsou zaznamenány.
MARK_OK	MARK_OK je vráceno pro označení úspěchu.

Poznámky

Jsou-li značky a komentáře vloženy příkazem VSInstr Mark nebo funkcemi (CommentMarkAtProfile, CommentMarkProfile nebo MarkProfile), musí být stav profilování vlákna obsahujícího funkci Mark Profile "on".

Značky profilu jsou v rámci rozsahu globální.Například značka profilu vložená do jednoho vlákna může být použita pro označení začátku nebo konce segmentu dat v libovolném vlákně v rámci souboru .vsp.

Důležité
Metodu CommentMarkProfile lze použít pouze při instrumentaci.

Ekvivalent v rozhraní .NET Framework

Microsoft.VisualStudio.Profiler.dll

Informace o funkci

Záhlaví	VSPerf.h
Knihovna	VSPerf.lib
Unicode	Implementováno jako: CommentMarkProfileW (Unicode) a CommentMarkProfileA (ANSI).

Příklad

Následující kód ukazuje volání funkce CommentMarkProfile.Pro určení, zda kód volá funkci ANSI, předpokládá příklad použití řetězcových maker Win32 a nastavení kompilátoru Unicode.

void ExerciseCommentMarkProfile()
{
    // Declare and initalize variables to pass to 
    // CommentMarkProfile.  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.
    long markId = 01;
    TCHAR * markText = TEXT("Exercising CommentMarkProfile...");

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

    // Declare MarkOperationResult Enumerator.  
    // Holds return value from call to CommentMarkProfile.
    PROFILE_COMMAND_STATUS markResult;

    markResult = CommentMarkProfile(
        markId,
        markText);

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

#ifdef DEBUG
    OutputDebugString(tchBuffer);
#endif
}

Viz také

Další zdroje

Referenční dokumentace rozhraní API produktu Visual Studio Profiler (nativní)

Sdílet prostřednictvím