POPLISTFUNC
El IDE proporciona esta devolución de llamada al SccPopulateList y la usa el complemento de control de código fuente para actualizar una lista de archivos o directorios (también proporcionados a la SccPopulateList
función).
Cuando un usuario elige el comando Obtener en el IDE, el IDE muestra un cuadro de lista de todos los archivos que el usuario puede obtener. Desafortunadamente, el IDE no conoce la lista exacta de todos los archivos que el usuario podría obtener; solo el complemento tiene esta lista. Si otros usuarios han agregado archivos al proyecto de control de código fuente, estos archivos deben aparecer en la lista, pero el IDE no los conoce. El IDE crea una lista de los archivos que cree que el usuario puede obtener. Antes de que muestre esta lista al usuario, llama a SccPopulateList,
, lo que proporciona al complemento de control de código fuente la oportunidad de agregar y eliminar archivos de la lista.
Signature
El complemento de control de código fuente modifica la lista llamando a una función implementada por el IDE con el siguiente prototipo:
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
Parámetros
pvCallerData El pvCallerData
parámetro pasado por el autor de la llamada (el IDE) al SccPopulateList. El complemento de control de código fuente no debe asumir nada sobre el contenido de este parámetro.
fAddRemove Si TRUE
es , lpFileName
es un archivo que se debe agregar a la lista de archivos. Si FALSE
es , lpFileName
es un archivo que se debe eliminar de la lista de archivos.
nStatus Status de lpFileName
(una combinación de los SCC_STATUS
bits; vea File Status Code para obtener más información).
lpFileName Ruta de acceso de directorio completa del nombre de archivo que se va a agregar o eliminar de la lista.
Valor devuelto
Value | Descripción |
---|---|
TRUE |
El complemento puede seguir llamando a esta función. |
FALSE |
Se ha producido un problema en el IDE (por ejemplo, una situación de memoria insuficiente). El complemento debe detener la operación. |
Comentarios
Para cada archivo que el complemento de control de código fuente desea agregar o eliminar de la lista de archivos, llama a esta función y pasa .lpFileName
La fAddRemove
marca indica un nuevo archivo que se va a agregar a la lista o a un archivo antiguo que se va a eliminar. El nStatus
parámetro proporciona el estado del archivo. Cuando el complemento SCC ha terminado de agregar y eliminar archivos, devuelve de la llamada SccPopulateList .
Nota:
El SCC_CAP_POPULATELIST
bit de funcionalidad es necesario para Visual Studio.