Funções de API plug-in de controle de origem

A API de plug-in de controle de origem fornece as seguintes funções, que devem ser implementadas pelo plug-in de acordo com essa API de controle de origem. As assinaturas de cada função e a semântica associados com os sinalizadores de bit e outros parâmetros são descritos em detalhes nesta referência.

Funções de manutenção do sistema e inicialização

Função	Descrição
Função SccCloseProject	Fecha um projeto.
Função SccGetCommandOptions	Solicita ao usuário para opções avançadas para o comando fornecido.
Função SccGetVersion	Retorna a versão do controle da fonte de plug-in.
Função SccInitialize	Inicializa o plug-in de controle de origem. Ele é chamado uma vez para cada instância do plug-in.
Função SccOpenProject	Abre um projeto.
Função SccSetOption	Uma função genérica usada para definir uma ampla variedade de opções. Cada opção começa com SCC_OPT_xxx e tem seu próprio conjunto definido de valores.
Função SccUninitialize	Chamado depois que quando um plug-in de controle de origem precisa ser desconectado.

Principais funções de controle de origem

Função	Descrição
Função SccAdd	Adiciona uma matriz de arquivos especificados pelos nomes de caminho totalmente qualificado para o sistema de controle de origem.
Função SccAddFromScc	Permite que o usuário procurar arquivos que já estão no sistema de controle de origem e faça parte desses arquivos, do projeto atual.
Função SccCheckin	Verifica-se em uma matriz de arquivos.
Função SccCheckout	Faz o check out de uma matriz de arquivos.
Função SccDiff	Mostra as diferenças entre o arquivo do usuário local, especificado por um nome de caminho totalmente qualificado e a versão sob controle de origem.
Função SccGet	Recupera uma cópia somente leitura de um conjunto de arquivos.
Função SccGetEvents	Verifica o status dos arquivos que o chamador solicitou sobre (via SccQueryInfo).
Função SccGetProjPath	Faz com que o plug-in para solicitar ao usuário para um caminho de projeto que seja significativo para o plug-in de controle de origem.
Função SccHistory	Mostra o histórico para uma matriz de nomes de arquivo local totalmente qualificado.
Função SccPopulateList	Examina a lista de arquivos para o seu status atual. Além disso, usa a pfnPopulate a função para notificar o chamador quando um arquivo não coincide com os critérios para o nCommand.
Função SccProperties	Mostra as propriedades de um arquivo totalmente qualificado.
Função SccQueryInfo	Examina uma lista de arquivos totalmente qualificados para o seu status atual.
Função SccRemove	Remove a matriz de arquivos totalmente qualificados do sistema de controle de origem.
Função SccRename	Renomeia o arquivo fornecido para um novo nome no sistema de controle de origem.
Função SccRunScc	Acessa a lista completa dos recursos do sistema de controle de origem.
Função SccUncheckout	Desfaz um check-out de uma matriz de arquivos.

Funciona essa capacidade adicional de suporte (versão 1.2 do controle de origem API plug-in)

Este grupo de funções de define a funcionalidade adicional incluída na versão 1.2 da API de plug-in de controle de origem. Eles fornecem acesso a recursos de controle de origem e os recursos mais avançados.

Função	Descrição
Função SccBeginBatch	Inicia uma operação de lote.
Função SccCreateSubProject	Cria um subprojeto com o nome fornecido em um projeto existente do pai.
Função SccDirDiff	Mostra as diferenças entre o diretório do usuário local, especificado por um nome de caminho totalmente qualificado e o local de banco de dados de controle de origem.
Função SccDirQueryInfo	Examina uma lista de diretórios totalmente qualificados para o seu status atual.
Função SccEndBatch	Termina uma operação em lotes.
Função SccGetParentProjectPath	Retorna pai o caminho do projeto determinado (o projeto deve existir).
Função SccIsMultiCheckoutEnabled	Verifica se a vários checkouts em um arquivo são permitidos.
Função SccWillCreateSccFile	Verifica se o plug-in criará MSSCCPRJ.Arquivos SCC.

Funções que o suporte avançado a capacidade (versão 1.3 a API de plug-in de controle de origem)

Este grupo de funções de define a funcionalidade adicional incluída na versão 1.3 da API de plug-in de controle de origem. Eles fornecem acesso a recursos de controle de origem e os recursos mais avançados.

Função	Descrição
Função SccAddFilesFromSCC	Adiciona uma lista dos arquivos de controle de origem ao projeto atual.
Função SccBackgroundGet	Recupera uma lista de arquivos de controle de origem sem interface do usuário.
Função SccEnumChangedFiles	Recupera uma lista de arquivos que são diferentes dos arquivos locais no controle de origem.
Função SccGetExtendedCapabilities	Recupera os sinalizadores que especificam os recursos estendidos com suporte a plug-in de controle de origem.
Função SccGetUserOption	Recupera as opções específicas do usuário.
Função SccPopulateDirList	Examina uma lista de diretórios e arquivos em um projeto ou projetos que estão sob controle de origem. Cada nome de diretório e arquivo encontrado é passado para uma função de retorno de chamada.
Função SccQueryChanges	Examina as alterações de nome feitas para uma lista de arquivos. Cada nome de arquivo é passado para uma função de retorno de chamada com seu status de alteração.

Requisitos

Cabeçalho: scc.h

(Fornecido no SDK do ambiente comum inclui pasta, por padrão [drive]\Program Files\VSIP 8.0\EnvSDK\common\inc; também é fornecido na pasta VSIP com amostra MSSCCI, [drive]\Program Files\VSIP 8.0\MSSCCI).

Consulte também

Outros recursos

Plug-ins de controle de origem

Criar um controle de origem plug-in