Função SccGetEvents

  • Artigo

Essa função recupera um evento de status em fila.

Sintaxe

SCCRTN SccGetEvents (
   LPVOID pvContext,
   LPSTR  lpFileName,
   LPLONG lpStatus,
   LPLONG pnEventsRemaining
);

Parâmetros

pvContexto

[em] A estrutura de contexto do plug-in de controle do código-fonte.

lpFileName

[dentro, fora] Buffer onde o plug-in de controle do código-fonte coloca o nome do arquivo retornado (até _MAX_PATH caracteres).

lpStatus

[dentro, fora] Retorna o código de status (consulte Código de status do arquivo para obter valores possíveis).

pnEventsRestante

[dentro, fora] Retorna o número de entradas deixadas na fila após essa chamada. Se esse número for grande, o chamador pode decidir chamar o SccQueryInfo para obter todas as informações de uma só vez.

Valor retornado

Espera-se que a implementação do plug-in de controle do código-fonte dessa função retorne um dos seguintes valores:

Valor Descrição
SCC_OK Obtenha eventos bem-sucedidos.
SCC_E_OPNOTSUPPORTED Não há suporte para essa função.
SCC_E_NONSPECIFICERROR Falha inespecífica.

Comentários

Essa função é chamada durante o processamento ocioso para ver se houve atualizações de status para arquivos sob controle do código-fonte. O plug-in de controle do código-fonte mantém o status de todos os arquivos que conhece e, sempre que uma alteração de status é anotada pelo plug-in, o status e o arquivo associado são armazenados em uma fila. Quando SccGetEvents é chamado, o elemento superior da fila é recuperado e retornado. Essa função é restrita a retornar apenas informações armazenadas em cache anteriormente e deve ter um retorno muito rápido (ou seja, nenhuma leitura do disco ou solicitação de status ao sistema de controle de origem); caso contrário, o desempenho do IDE pode começar a degradar-se.

Se não houver nenhuma atualização de status a ser relatada, o plug-in de controle de origem armazenará uma cadeia de caracteres vazia no buffer apontado por lpFileName. Caso contrário, o plug-in armazena o nome completo do caminho do arquivo cujas informações de status foram alteradas e retorna o código de status apropriado (um dos valores detalhados em Código de status do arquivo).

Confira também