DataCollection.CommentMarkProfile, méthode

Article
08/10/2011

La méthode CommentMarkProfile insère un marqueur numérique et une chaîne de texte dans le fichier .vsp. Le profilage du thread contenant la fonction CommentMarkProfile doit être ON pour que la marque et le commentaire soient insérés.

Espace de noms : Microsoft.VisualStudio.Profiler
Assembly : Microsoft.VisualStudio.Profiler (dans Microsoft.VisualStudio.Profiler.dll)

Syntaxe

'Déclaration
Public Shared Function CommentMarkProfile ( _
    markId As Integer, _
    markText As String _
) As MarkOperationResult

public static MarkOperationResult CommentMarkProfile(
    int markId,
    string markText
)

public:
static MarkOperationResult CommentMarkProfile(
    int markId, 
    String^ markText
)

static member CommentMarkProfile : 
        markId:int * 
        markText:string -> MarkOperationResult

public static function CommentMarkProfile(
    markId : int, 
    markText : String
) : MarkOperationResult

Paramètres

markId
Type : System.Int32
Marqueur numérique à insérer.Le marqueur doit être supérieur ou égal à 0 (zéro).

markText
Type : System.String
Pointeur sur la chaîne de texte à insérer.La chaîne doit être inférieure à 256 caractères y compris le terminateur NULL.

Valeur de retour

Type : Microsoft.VisualStudio.Profiler.MarkOperationResult
La valeur de retour, MarkOperationResult, est un enum.

Notes

L'état de profilage du thread qui contient la fonction de profil de la marque doit être activé lorsque les marques et les commentaires sont insérés à l'aide de la commande VSInstr Mark ou des fonctions membres Microsoft.VisualStudio.Profiler.DataCollection (CommentMarkAtProfile, CommentMarkProfile ou MarkProfile).

Les marques de profil sont globales dans la portée. Par exemple, une marque de profil insérée dans un seul thread peut être utilisée pour marquer le début ou la fin d'un segment de données de n'importe quel thread dans le fichier .vsp.

Important

Les méthodes CommentMarkProfile doivent être utilisées uniquement avec l'instrumentation.

Exemples

L'exemple suivant illustre la méthode MarkOperationResult.

        public void ExerciseMarkOperationResult()
        {
            // 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 = 4;

            // Declare enumeration to hold return value of 
            // call to MarkProfile.
            MarkOperationResult result;

            result = DataCollection.MarkProfile(markID);

            // Compare result to MarkOperationResult value.  
            // In this case, the property value of 
            // MarkOperationResult is "OK".
            if (result == MarkOperationResult.OK)
            {
                Console.WriteLine("PASS -- Test {0}", result);
            }
            else
            {
                Console.WriteLine("FAIL -- MarkProfile Returned code {0} with normal input", result.ToString());
            }
        }

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

DataCollection Classe

Microsoft.VisualStudio.Profiler, espace de noms

Partager via