CommentMarkAtProfile

Artigo
08/25/2010

The CommentMarkAtProfile método insere um valor de carimbo de data/hora, uma marca numérica e uma seqüência de caracteres de comentário no arquivo Vsp. O valor de carimbo de data/hora pode ser usado para sincronizar eventos externos.Para a marca e comentário a ser inserido, a criação de perfil para o segmento que contém a função CommentMarkAtProfile deve ser ON.

PROFILE_COMMAND_STATUS PROFILERAPI CommentMarkAtProfileA(
                                                                      __int64 dnTimestamp,
                                                                      long lMarker,
                                                                      LPCTSTR szComment);

Parâmetros

dnTimestamp

Um inteiro de 64 bit que representa um valor de carimbo de data/hora.

lMarker

O marcador numérico para inserir.O marcador deve maior que ou igual a 0 (zero).

szComment

Um ponteiro para a seqüência de caracteres de texto para inserir.A seqüência de caracteres deve ter menos de 256 caracteres, incluindo o terminador nulo.

Valor de Propriedade/Valor Retornado

A função indica sucesso ou fracasso usando PROFILE_COMMAND_STATUS enumeração.O valor retornado pode ser uma das seguintes opções:

Enumerador	Descrição
MARK_ERROR_MARKER_RESERVED	O parâmetro é menor ou igual a 0.Esses valores são reservados.A marca e comentário não são registrados.
MARK_ERROR_MODE_NEVER	O modo de criação de perfil foi conjunto nunca quando a função foi chamado.A marca e comentário não são registrados.
MARK_ERROR_MODE_OFF	O modo de criação de perfil foi definido como OFF quando a função foi chamada.A marca e comentário não são registrados.
MARK_ERROR_NO_SUPPORT	Não há marca suporte neste contexto.A marca e comentário não são registrados.
MARK_ERROR_OUTOFMEMORY	Não havia memória disponível para registrar o evento.A marca e comentário não são registrados.
MARK_TEXTTOOLONG	A seqüência de caracteres excede o máximo de 256 caracteres.A seqüência de comentário será truncada e a marca e comentário são registradas.
MARK_OK	MARK_OK é retornada para indicar êxito.

Comentários

O estado de analisar para o thread que contém a marca de função de analisar deve estar em quando marcas e comentários inseridos com o comando marcar ou com funções de API (CommentMarkAtProfile, CommentMarkProfile ou MarkProfile).Marcas de analisar são global em escopo.Por exemplo, uma marca de analisar inserida em um thread pode ser usada para marcar o início ou participante de um segmento de dados em qualquer thread no arquivo Vsp.

Observação importante:
Métodos CommentMarkAtProfile devem ser usados com a instrumentação somente.

Equivalente do NET Framework

Microsoft.VisualStudio.criador de perfil.dll

Informações de função

Header	Incluir VSPerf.h
Biblioteca	Use VSPerf.lib
Unicode	Implementada sistema autônomo CommentMarkAtProfileW (Unicode) e CommentMarkAtProfileA (ANSI).

Exemplo

O código a seguir ilustra o uso da telefonar de função genérico CommentMarkAtProfile.O exemplo supõe que o uso de macros de seqüência de caracteres Win32 e as configurações do compilador para ANSI determinar se as chamadas de código o ANSI habilitados função.

void ExerciseCommentMarkAtProfile(void)
{
    // 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.
    int64 timeStamp = 0x1111;
    long markId = 01;
    TCHAR * markText = TEXT("Exercising CommentMarkAtProfile...");

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

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

    markResult = CommentMarkAtProfile(
        timeStamp,
        markId,
        markText);

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

#ifdef DEBUG
    OutputDebugString(tchBuffer);
#endif
}

Consulte também

Outros recursos

(Nativa) de referência do API criador de perfil do Visual Studio

Compartilhar via