Compartir vía

Función SccGetEvents

  • Artículo

Esta función recupera un evento de estado en cola.

Sintaxis

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

Parámetros

pvContext

[in] Estructura del contexto del complemento de control de código fuente.

lpFileName

[dentro, fuera] Búfer donde el complemento de control de código fuente coloca el nombre de archivo devuelto (hasta _MAX_PATH caracteres).

lpStatus

[dentro, fuera] Devuelve el código de estado (consulte Código de estado del archivo para ver los valores posibles).

pnEventsRemaining

[dentro, fuera] Devuelve el número de entradas que quedan en la cola después de esta llamada. Si este número es grande, el autor de la llamada puede decidir llamar a SccQueryInfo para obtener toda la información a la vez.

Valor devuelto

Se espera que la implementación del complemento de control de código fuente de esta función devuelva uno de los siguientes valores:

Value Descripción
SCC_OK Obtención de eventos realizados correctamente.
SCC_E_OPNOTSUPPORTED Esta función no se admite.
SCC_E_NONSPECIFICERROR Error no específico.

Comentarios

Se llama a esta función durante el procesamiento inactivo para ver si se han producido actualizaciones de estado para los archivos bajo control de código fuente. El complemento de control de código fuente mantiene el estado de todos los archivos que conoce y cada vez que el complemento anota un cambio de estado, el estado y el archivo asociado se almacenan en una cola. Cuando SccGetEvents se llama a , se recupera y devuelve el elemento superior de la cola. Esta función está restringida para devolver solo información almacenada previamente en caché y debe tener una solución alternativa muy rápida (es decir, sin leer el disco ni pedir al sistema de control de código fuente el estado); De lo contrario, el rendimiento del IDE puede empezar a degradarse.

Si no hay ninguna actualización de estado para informar, el complemento de control de código fuente almacena una cadena vacía en el búfer al que lpFileNameapunta . De lo contrario, el complemento almacena el nombre de ruta de acceso completo del archivo para el que ha cambiado la información de estado y devuelve el código de estado adecuado (uno de los valores detallados en Código de estado de archivo).

Consulte también