POPLISTFUNC
Esse retorno de chamada é fornecido para o Função SccPopulateList pelo IDE e é usado pelo plug-in de controle de origem para atualizar uma lista de arquivos ou diretórios (também é fornecido para o SccPopulateList função).
Quando um usuário escolhe o obter de comando no IDE, o IDE exibe uma caixa de listagem de todos os arquivos que o usuário pode receber. Infelizmente, o IDE não sabe a lista exata de todos os arquivos que o usuário poderá obter; somente o plug-in tem esta lista. Se outros usuários tem adicionado os arquivos para o projeto de controle de código fonte, esses arquivos devem aparecer na lista, mas o IDE não sabe sobre eles. O IDE constrói uma lista dos arquivos que ele considera que o usuário pode receber. Antes de exibir esta lista para o usuário, ele chama o Função SccPopulateList, dando o plug-in de controle de origem a oportunidade de adicionar e excluir arquivos da lista.
Assinatura
O plug-in de controle de origem modifica a lista chamando uma função implementada a 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 (IDE) para o Função SccPopulateList. O plug-in de controle de origem deve presumir que nada sobre o conteúdo desse parâmetro.fAddRemove
Se 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 do lpFileName (uma combinação da SCC_STATUS bits; consulte Enumerador de código de Status de arquivos. para obter detalhes).lpFileName
Caminho completo do diretório do nome do arquivo para adicionar ou excluir da lista.
Valor de retorno
Valor |
Descrição |
|---|---|
TRUE |
O plug-in pode continuar chamar essa função. |
FALSE |
Houve um problema no lado do IDE (como a situação de memória insuficiente). O plug-in deve interromper a operação. |
Comentários
Para cada arquivo que deseja que o plug-in de controle de origem para adicionar ou excluir da lista de arquivos, ele chama essa função, passando a lpFileName. O fAddRemove sinalizador indica um novo arquivo para adicionar à lista ou um arquivo antigo para excluir. O nStatus parâmetro fornece o status do arquivo. Quando o plug-in de SCC concluiu a adição e exclusão de arquivos, ela retorna da Função SccPopulateList de chamada.
Dica
O SCC_CAP_POPULATELIST bit de recurso é necessário para Visual Studio.
Consulte também
Referência
Enumerador de código de Status de arquivos.