DataCollection.CommentMarkAtProfile (Método)

El método CommentMarkAtProfile inserta un valor de marca de tiempo, una marca numérica y una cadena de comentario en el archivo .vsp.El valor de la marca de tiempo se puede utilizar para sincronizar los eventos externos.La generación de perfiles para el subproceso que contiene la función CommentMarkAtProfile debe estar activada (ON) para que se inserten la marca y el comentario.

Espacio de nombres:  Microsoft.VisualStudio.Profiler
Ensamblado:  Microsoft.VisualStudio.Profiler (en Microsoft.VisualStudio.Profiler.dll)

Sintaxis

'Declaración
Public Shared Function CommentMarkAtProfile ( _
    timestamp As Long, _
    markId As Integer, _
    markText As String _
) As MarkOperationResult
public static MarkOperationResult CommentMarkAtProfile(
    long timestamp,
    int markId,
    string markText
)
public:
static MarkOperationResult CommentMarkAtProfile(
    long long timestamp, 
    int markId, 
    String^ markText
)
static member CommentMarkAtProfile : 
        timestamp:int64 * 
        markId:int * 
        markText:string -> MarkOperationResult 
public static function CommentMarkAtProfile(
    timestamp : long, 
    markId : int, 
    markText : String
) : MarkOperationResult

Parámetros

  • timestamp
    Tipo: System.Int64
    Entero de 64 bits que representa un valor de marca de tiempo.
  • markId
    Tipo: System.Int32
    Marcador numérico que se inserta.El marcador debe ser mayor o igual que 0 (cero).
  • markText
    Tipo: System.String
    Puntero a la cadena de texto que se inserta.La cadena debe ser tener menos de 256 caracteres incluido el terminador NULL.

Valor devuelto

Tipo: Microsoft.VisualStudio.Profiler.MarkOperationResult
El valor devuelto, MarkOperationResult, es una enumeración.

Comentarios

El estado de generación de perfiles del subproceso que contiene la función de perfil de marcas debe estar activado cuando se inserten marcas o comentarios con el comando Mark o con las funciones de la API (CommentMarkAtProfile, CommentMarkProfile o MarkProfile).Las marcas de perfil tienen un ámbito global.Por ejemplo, una marca de perfil insertada en un subproceso se puede utilizar para marcar el inicio y el final de un segmento de datos en cualquier subproceso del archivo .vsp.

Nota importanteImportante

Los métodos CommentMarkAtProfile sólo se deben utilizar con la instrumentación.

Ejemplos

En el ejemplo siguiente se ilustra una llamada al método CommentMarkAtProfile.

        public void ExerciseCommentMarkAtProfile()
        {
            // Declare and initalize variables to pass to 
            // CommentMarkAtProfile.  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 timestamp = 0x1111;
            int markId = 01;
            string markText = "Exercising CommentMarkAtProfile...";

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

            markResult = DataCollection.CommentMarkAtProfile(
                timestamp,
                markId,
                markText);

            // Check result of CommentMarkAtProfile call.
            Console.WriteLine("CommentMarkAtProfile returned {0}",
                markResult); 
        }

Seguridad de .NET Framework

Vea también

Referencia

DataCollection Clase

Microsoft.VisualStudio.Profiler (Espacio de nombres)