POPLISTFUNC
Esse retorno de chamada é fornecido ao SccPopulateList pelo IDE e é usado pelo plug-in de controle do código-fonte para atualizar uma lista de arquivos ou diretórios (também fornecidos à SccPopulateList função).
Quando um usuário escolhe o comando Get no IDE, o IDE exibe uma caixa de listagem de todos os arquivos que o usuário pode obter. Infelizmente, o IDE não sabe a lista exata de todos os arquivos que o usuário pode obter; apenas o plug-in tem essa lista. Se outros usuários adicionaram arquivos ao projeto de controle do código-fonte, esses arquivos devem aparecer na lista, mas o IDE não sabe sobre eles. O IDE cria uma lista dos arquivos que ele acha que o usuário pode obter. Antes de exibir essa lista para o usuário, ele chama o SccPopulateList, , dando ao plug-in de controle do código-fonte a chance de adicionar e excluir arquivos da lista.
Signature
O plug-in de controle do código-fonte modifica a lista chamando uma função implementada pelo IDE com o seguinte protótipo:
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
Parâmetros
pvCallerData O pvCallerData parâmetro passado pelo chamador (o IDE) para o SccPopulateList. O plug-in de controle do código-fonte não deve assumir nada sobre o conteúdo desse parâmetro.
fAddRemove If TRUE, lpFileName é um arquivo que deve ser adicionado à lista de arquivos. Se FALSE, lpFileName é um arquivo que deve ser excluído da lista de arquivos.
nStatus Status de (uma combinação dos bits; consulte Código de SCC_STATUS Status do lpFileName Arquivo para obter detalhes).
lpFileName Caminho completo do diretório do nome do arquivo a ser adicionado ou excluído da lista.
Valor retornado
| Valor | Descrição |
|---|---|
TRUE |
O plug-in pode continuar chamando essa função. |
FALSE |
Houve um problema no lado do IDE (como uma situação de falta de memória). O plug-in deve parar de funcionar. |
Comentários
Para cada arquivo que o plug-in de controle do código-fonte deseja adicionar ou excluir da lista de arquivos, ele chama essa função, passando o lpFileName. O fAddRemove sinalizador indica um novo arquivo a ser adicionado à lista ou um arquivo antigo a ser excluído. O nStatus parâmetro fornece o status do arquivo. Quando o plug-in SCC terminar de adicionar e excluir arquivos, ele retornará da chamada SccPopulateList .
Observação
O SCC_CAP_POPULATELIST bit de capacidade é necessário para o Visual Studio.