DataCollection.CommentMarkProfile (Método)

El método CommentMarkProfile inserta un marcador numérico y una cadena de texto en el archivo .vsp.La generación de perfiles para el subproceso que contiene la función CommentMarkProfile 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 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

Parámetros

  • 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 VSInstr Mark o con funciones miembro de Microsoft.VisualStudio.Profiler.DataCollection (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 CommentMarkProfile solo se deben utilizar con la instrumentación.

Ejemplos

En el siguiente ejemplo se ilustra el método 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());
            }
        }

Seguridad de .NET Framework

Vea también

Referencia

DataCollection Clase

Microsoft.VisualStudio.Profiler (Espacio de nombres)