CommentMarkProfile

Artigo
08/08/2011

O CommentMarkProfile função insere um marcador numérico e uma seqüência de texto no arquivo. vsp. Para a marca e a comentar a ser inserido, criação de perfil para o segmento que contém o CommentMarkProfile função deve estar Diante.

PROFILE_COMMAND_STATUS PROFILERAPI CommentMarkProfile(
                                   long lMarker, 
                                   LPCTSTR szComment);

Parâmetros

lMarker

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

szComment

Ponteiro para a seqüência de texto para inserir. A seqüência de caracteres deve ser menor que 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 de retorno pode ser um destes procedimentos:

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

Comentários

O estado de perfil para o segmento que contém a função de perfil da marca deve estar em quando marcas e comentários inseridos com o comando VSInstr marca ou com funções (CommentMarkAtProfile, CommentMarkProfile ou MarkProfile).

Marcas de perfil são globais em escopo. Por exemplo, uma marca de perfil inserida em um thread pode ser usada para marcar o início ou fim de um segmento de dados em qualquer segmento no arquivo. vsp.

Importante
CommentMarkProfile método só pode ser usado com a instrumentação.

Equivalente do NET Framework

Microsoft.VisualStudio.Profiler.dll

Informações de função

Header	Incluir VSPerf.h
Biblioteca	Usar VSPerf.lib
Unicode	Implementada como CommentMarkProfileW (Unicode) e CommentMarkProfileA (ANSI).

Exemplo

O código a seguir ilustra a chamada de função CommentMarkProfile. O exemplo supõe que o uso de macros de seqüência de caracteres de Win32 e as configurações do compilador de Unicode para determinar se o código chama o ANSI chamada 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

Profiler Referência API do Visual Studio (nativos)

Compartilhar via