Função SccPopulateList

Artigo
05/18/2015

Essa função atualiza uma lista de arquivos para um comando de controle de origem específica e fornece o status de controle de origem em todos os arquivos de determinado.

SCCRTN SccPopulateList (
   LPVOID          pvContext,
   enum SCCCOMMAND nCommand,
   LONG            nFiles,
   LPCSTR*         lpFileNames,
   POPLISTFUNC     pfnPopulate,
   LPVOID          pvCallerData,
   LPLONG          lpStatus,
   LONG            fOptions
);

Parâmetros

pvContext
[in] A estrutura de contexto de plug-in de controle de origem.
nCommand
[in] O comando de controle de origem que será aplicado a todos os arquivos do lpFileNames array (consulte Enumerador de código de comando para obter uma lista de comandos possíveis).
nFiles
[in] Número de arquivos de lpFileNames array.
lpFileNames
[in] Uma matriz de nomes de arquivo conhecidos ao IDE.
pfnPopulate
[in] A função de retorno de chamada IDE para chamar para adicionar e remover arquivos (consulte POPLISTFUNC para obter detalhes).
pvCallerData
[in] Valor que deve ser passado inalterada para a função de retorno de chamada.
lpStatus
[in, out] Uma matriz para o plug-in para retornar os sinalizadores de status para cada arquivo de controle de origem.
fOptions
[in] Sinalizadores de comando (consulte a seção "PopulateList flag" Sinalizadores de bit usado por comandos específicos para obter detalhes).

Valor de retorno

A implementação de plug-in de controle de origem dessa função deve retornar um dos seguintes valores:

Valor	Descrição
SCC_OK	Sucesso.
SCC_E_NONSPECIFICERROR	Falha de não-específica.

Comentários

Esta função examina a lista de arquivos para seu status atual. Ele usa o pfnPopulate função de retorno de chamada para notificar o chamador quando um arquivo não coincide com os critérios para o nCommand. Por exemplo, se o comando SCC_COMMAND_CHECKIN um arquivo na lista não está com check-out e o retorno de chamada é usado para informar o chamador. Ocasionalmente, o plug-in de controle de origem pode encontrar outros arquivos que poderiam ser parte do comando e adicioná-los. Isso permite, por exemplo, um usuário Visual Basic fazer check-out de um arquivo. bmp que é usado pelo seu projeto, mas não aparece no arquivo de projeto Visual Basic. Um usuário escolhe o obter comando no IDE. O IDE exibirá uma lista de todos os arquivos que ele considera que o usuário pode receber, mas antes que a lista é mostrada, o SccPopulateList função é chamada para certificar-se de que a lista a ser exibido é atualizada.

Exemplo

O IDE constrói uma lista de arquivos que ele considera que o usuário pode receber. Antes de exibir esta lista, ele chama o SccPopulateList function, dando o plug-in de controle de origem a oportunidade de adicionar e excluir arquivos da lista. Modifica o plug-in na lista chamando a função de retorno de chamada determinado (consulte POPLISTFUNC para obter mais detalhes).

Continua o plug-in chamar o pfnPopulate função, que adiciona e exclui arquivos, quando ele for concluído e, em seguida, retorna a partir do SccPopulateList função. O IDE pode exibir sua lista. O lpStatus matriz representa todos os arquivos na lista original passado pelo IDE. O plug-in, preenche o status de todos esses arquivos além tomada usa a função de retorno de chamada.

Dica

Um plug-in de controle de fonte sempre tem a opção para simplesmente retornar imediatamente a partir dessa função, deixando a lista como está.Se um plug-in implementa essa função, ele pode indicar isso definindo a SCC_CAP_POPULATELIST sinalizador de bit de recurso na primeira chamada para o Função SccInitialize.Por padrão, o plug-in deve sempre considerar que todos os itens que estão sendo passados são arquivos.No entanto, se o IDE define o SCC_PL_DIR sinalizador na fOptions parâmetro, todos os itens que está sendo passados devem ser considerados diretórios.O plug-in deve adicionar todos os arquivos que pertençam nos diretórios.O IDE nunca irá passar um misto de arquivos e diretórios.