CommentMarkProfile

Artigo
08/25/2010

The CommentMarkProfile função insere um marcador numérico e uma seqüência de caracteres de texto no arquivo Vsp. Para a marca e comentário a ser inserido, criação de perfil para o thread que contém o CommentMarkProfile função deve estar ativado.

PROFILE_COMMAND_STATUS PROFILERAPI CommentMarkProfileA(
                                                                      long lMarker, 
                                                                      LPCTSTR szComment);

Parâmetros

lMarker

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

szComment

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 segmento que contém a função de analisar de marca deve estar na quando marcas e comentários inseridos com o comando Marcar VSInstr ou funções (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étodo CommentMarkProfile só pode ser usado com a instrumentação.

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 CommentMarkProfileW (Unicode) e CommentMarkProfileA (ANSI).

Exemplo

O código a seguir ilustra a telefonar de função CommentMarkProfile.O exemplo supõe que o uso de macros de seqüência de caracteres Win32 e as configurações do compilador Unicode para determinar se o código chama o ANSI telefonar de função.

void ExerciseCommentMarkProfile()
{
    // Declare and initalize variables to pass to 
    // CommentMarkProfile.  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 markId = 01;
    TCHAR * markText = TEXT("Exercising CommentMarkProfile...");

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

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

    markResult = CommentMarkProfile(
        markId,
        markText);

    // Format and print result.
    LPCTSTR pszFormat = TEXT("%s %d.\0");
    TCHAR* pszTxt = TEXT("CommentMarkProfile 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