SuspendProfile

Article
08/21/2008

Mise à jour : novembre 2007

La méthode SuspendProfile incrémente le compteur de Suspend/Resume pour le niveau de profilage spécifié.

PROFILE_COMMAND_STATUS PROFILERAPI SuspendProfile(
                       PROFILE_CONTROL_LEVEL Level, 
                       unsigned int dwId);

Paramètres

Level

Indique le niveau de profil auquel la collection de données de performance peut être appliquée. Les énumérateurs PROFILE_CONTROL_LEVEL suivants permettent d'indiquer l'un des trois niveaux auxquels la collection des données de performance peut être appliquée :

Énumerateur	Description
PROFILE_GLOBALLEVEL	Le paramètre de niveau global affecte tous les processus et threads dans l'exécution du profilage.
PROFILE_PROCESSLEVEL	Le paramètre au niveau du processus affecte tous les threads qui font partie du processus spécifié.
PROFILE_THREADLEVEL	Le paramètre au niveau du profilage du thread affecte le thread spécifié.

dwId

Identificateur de processus ou de thread généré par le système.

Valeur de propriété/valeur de retour

La fonction indique la réussite ou l'échec en utilisant l'énumération PROFILE_COMMAND_STATUS. La valeur de retour peut être l'une des suivantes :

Énumerateur	Description
PROFILE_ERROR_ID_NOEXIST	L'ID de l'élément de profilage n'existe pas.
PROFILE_ERROR_LEVEL_NOEXIST	Le niveau de profilage spécifié n'existe pas.
PROFILE_ERROR_MODE_NEVER	La valeur NEVER a été affectée au mode de profilage lors de l'appel à la fonction.
PROFILE_ERROR_NOT_YET_IMPLEMENTED	L'appel de la fonction de profilage, le niveau de profilage ou une combinaison de l'appel et du niveau n'est pas encore implémenté.
PROFILE_OK	L'appel a réussi.

Notes

La valeur initiale du compteur de Suspend/Resume est de 0. Chaque appel à SuspendProfile ajoute 1 au nombre de Suspend/Resume ; chaque appel à ResumeProfile soustrait 1.

Lorsque le nombre de Suspend/Resume est supérieur ou égal à 0, l'état Suspend/Resume du niveau est OFF. Lorsque le nombre est inférieur ou égal à 0, l'état Suspend/Resume est ON.

Lorsque l'état Start/Stop et l'état Suspend/Resume sont tous deux ON, l'état de profilage du niveau est ON. Pour qu'un thread soit profilé, les états au niveau global, du processus et du thread doivent être ON.

Équivalent .NET Framework

Microsoft.VisualStudio.Profiler.dll

Informations sur la fonction

En-tête : déclaré dans VSPerf.h

Importez la bibliothèque : VSPerf.lib

Exemple

L'exemple suivant illustre la méthode SuspendProfile. Cet exemple suppose qu'un appel antérieur à StartProfile a été effectué pour le processus ou le thread identifié par PROFILE_CURRENTID.

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.
            
    // Variables used to print output
    HRESULT hResult;
    TCHAR tchBuffer[256];

    // Declare enumeration to hold result of call
    // to SuspendProfile
    PROFILE_COMMAND_STATUS profileResult;

    profileResult = SuspendProfile(
        PROFILE_GLOBALLEVEL,
        PROFILE_CURRENTID);

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

#ifdef DEBUG
    OutputDebugString(tchBuffer);
#endif
}

Voir aussi

Autres ressources

Référence des API du générateur de profils Visual Studio (Native)

Partager via