Funções de API de plug-in de controle do código-fonte

Aplica-se a:yes Visual Studio noVisual Studio para Mac noVisual Studio Code

A API de Plug-in de Controle de Origem fornece as seguintes funções, que devem ser implementadas pelo plug-in de controle do código-fonte de acordo com essa API. As assinaturas de cada função e a semântica associadas aos sinalizadores de bit e outros parâmetros são descritas em detalhes nesta referência.

Funções de inicialização e limpeza

Função Descrição
SccCloseProject Fecha um projeto.
SccGetCommandOptions Solicita ao usuário opções avançadas para o comando especificado.
SccGetVersion Retorna a versão do plug-in de controle do código-fonte.
SccInitialize Inicializa o plug-in de controle do código-fonte. Ele é chamado uma vez para cada instância do plug-in.
SccOpenProject Abre um projeto.
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 de valores definido.
SccUninitialize Chamado uma vez quando um plug-in de controle do código-fonte precisa ser desconectado.

Funções principais de controle do código-fonte

Função Descrição
SccAdd Adiciona uma matriz de arquivos especificada por nomes de caminho totalmente qualificados ao sistema de controle do código-fonte.
SccAddFromScc Permite que o usuário procure arquivos que já estejam no sistema de controle do código-fonte e, em seguida, faça com que esses arquivos façam parte do projeto atual.
SccCheckin Verifica em uma matriz de arquivos.
SccCheckout Verifica uma matriz de arquivos.
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 do código-fonte.
SccGet Recupera uma cópia somente leitura de um conjunto de arquivos.
SccGetEvents Verifica o status dos arquivos que o chamador perguntou sobre (via SccQueryInfo).
SccGetProjPath Faz com que o plug-in de controle do código-fonte solicite ao usuário um caminho de projeto significativo para o plug-in.
SccHistory Mostra o histórico de uma matriz de nomes de arquivos locais totalmente qualificados.
SccPopulateList Examina a lista de arquivos para seu status atual. Além disso, usa a pfnPopulate função para notificar o chamador quando um arquivo não corresponde aos critérios do nCommand.
SccProperties Mostra as propriedades de um arquivo totalmente qualificado.
SccQueryInfo Examina uma lista de arquivos totalmente qualificados para seu status atual.
SccRemove Remove a matriz de arquivos totalmente qualificados do sistema de controle do código-fonte.
SccRename Renomeia o arquivo fornecido para um novo nome no sistema de controle do código-fonte.
SccRunScc Acessa toda a gama de recursos do sistema de controle do código-fonte.
SccUncheckout Desfaz um check-out de uma matriz de arquivos.

Funções que dão suporte a recursos adicionais (versão 1.2 da API de plug-in de controle do código-fonte)

Esse grupo de funções define a funcionalidade adicional incluída na versão 1.2 da API de Plug-in de Controle do Código-Fonte. Eles fornecem acesso a recursos e recursos de controle do código-fonte mais avançados.

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

Funções que dão suporte à funcionalidade avançada (versão 1.3 da API de plug-in de controle do código-fonte)

Esse grupo de funções define a funcionalidade adicional incluída na versão 1.3 da API de Plug-in de Controle do Código-Fonte. Eles fornecem acesso a recursos e recursos de controle do código-fonte mais avançados.

Função Descrição
SccAddFilesFromSCC Adiciona uma lista de arquivos do controle do código-fonte ao projeto atual.
SccBackgroundGet Recupera uma lista de arquivos do controle do código-fonte sem uma interface do usuário.
SccEnumChangedFiles Recupera uma lista de arquivos no controle do código-fonte que são diferentes dos arquivos locais.
SccGetExtendedCapabilities Recupera sinalizadores que especificam recursos estendidos compatíveis com o plug-in de controle do código-fonte.
SccGetUserOption Recupera opções específicas do usuário.
SccPopulateDirList Examina uma lista de diretórios e arquivos em um projeto ou projetos que estão sob controle do código-fonte. Cada diretório e o nome do arquivo encontrado são passados para uma função de retorno de chamada.
SccQueryChanges Examina as alterações de nome feitas em 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 na pasta do SDK de Ambiente comum inclui pasta, por padrão [unidade]\Arquivos de Programas\VSIP 8.0\EnvSDK\common\inc; também fornecido na pasta VSIP com o exemplo MSSCCI, [unidade]\Arquivos de Programas\VSIP 8.0\MSSCCI).

Confira também