Funções de API de plug-in de controle do código-fonteSource Control Plug-in API Functions

A API de plug-in de controle do código-fonte fornece as seguintes funções, que devem ser implementadas pelo plug-in de controle do código-fonte de acordo com essa API.The Source Control Plug-in API provides the following functions, which must be implemented by the source control plug-in in accordance with this API. As assinaturas de cada função e a semântica associada aos sinalizadores de bits e a outros parâmetros são descritas detalhadamente nessa referência.The signatures of each function and the semantics associated with the bit flags and other parameters are described in detail in this reference.

Funções de inicialização e manutençãoInitialization and Housekeeping Functions

FunçãoFunction DescriçãoDescription
SccCloseProjectSccCloseProject Fecha um projeto.Closes a project.
SccGetCommandOptionsSccGetCommandOptions Solicita ao usuário as opções avançadas para o comando fornecido.Prompts the user for advanced options for the given command.
SccGetVersionSccGetVersion Retorna a versão do plug-in de controle do código-fonte.Returns the version of the source control plug-in.
SccInitializeSccInitialize Inicializa o plug-in de controle do código-fonte.Initializes the source control plug-in. Ele é chamado uma vez para cada instância do plug-in.It is called once for each instance of the plug-in.
SccOpenProjectSccOpenProject Abre um projeto.Opens a project.
SccSetOptionSccSetOption Uma função genérica usada para definir uma ampla variedade de opções.A generic function used to set a wide variety of options. Cada opção começa com SCC_OPT_xxx e tem seu próprio conjunto definido de valores.Each option starts with SCC_OPT_xxx and has its own defined set of values.
SccUninitializeSccUninitialize Chamado uma vez quando um plug-in de controle do código-fonte precisa ser desconectado.Called once when a source control plug-in needs to be unplugged.

Funções de controle do código-fonte principalCore Source Control Functions

FunçãoFunction DescriçãoDescription
SccAddSccAdd Adiciona uma matriz de arquivos especificados por nomes de caminho totalmente qualificados ao sistema de controle do código-fonte.Adds an array of files specified by fully qualified path names to the source control system.
SccAddFromSccSccAddFromScc Permite que o usuário procure arquivos que já estão no sistema de controle do código-fonte e, em seguida, torne esses arquivos parte do projeto atual.Allows the user to browse for files that are already in the source control system and then make those files part of the current project.
SccCheckinSccCheckin Faz o check-in de uma matriz de arquivos.Checks in an array of files.
SccCheckoutSccCheckout Faz o check-out de uma matriz de arquivos.Checks out an array of files.
SccDiffSccDiff Mostra as diferenças entre o arquivo do usuário local especificado por um nome de caminho totalmente qualificado e a versão no controle do código-fonte.Shows the differences between the local user's file specified by a fully qualified path name and the version under source control.
SccGetSccGet Recupera uma cópia somente leitura de um conjunto de arquivos.Retrieves a read-only copy of a set of files.
SccGetEventsSccGetEvents Verifica o status dos arquivos sobre os quais o chamador pediu (via SccQueryInfo ).Checks the status of files that the caller has asked about (via SccQueryInfo).
SccGetProjPathSccGetProjPath Faz com que o plug-in de controle do código-fonte solicite ao usuário um caminho de projeto que seja significativo para o plug-in.Causes the source control plug-in to prompt the user for a project path that is meaningful to the plug-in.
SccHistorySccHistory Mostra o histórico de uma matriz de nomes de arquivos locais totalmente qualificados.Shows the history for an array of fully qualified local file names.
SccPopulateListSccPopulateList Examina a lista de arquivos em busca de seu status atual.Examines the list of files for their current status. Além disso, o usa a pfnPopulate função para notificar o chamador quando um arquivo não corresponde aos critérios para o nCommand .In addition, uses the pfnPopulate function to notify the caller when a file does not match the criteria for the nCommand.
SccPropertiesSccProperties Mostra as propriedades de um arquivo totalmente qualificado.Shows the properties of a fully qualified file.
SccQueryInfoSccQueryInfo Examina uma lista de arquivos totalmente qualificados para seu status atual.Examines a list of fully qualified files for their current status.
SccRemoveSccRemove Remove a matriz de arquivos totalmente qualificados do sistema de controle do código-fonte.Removes the array of fully qualified files from the source control system.
SccRenameSccRename Renomeia o arquivo fornecido com um novo nome no sistema de controle do código-fonte.Renames the given file to a new name in the source control system.
SccRunSccSccRunScc Acessa a gama completa de recursos do sistema de controle do código-fonte.Accesses the full range of features of the source control system.
SccUncheckoutSccUncheckout Desfaz um check-out de uma matriz de arquivos.Undoes a checkout of an array of files.

Funções que dão suporte a recursos adicionais (versão 1,2 da API de plug-in de controle do código-fonte)Functions that Support Additional Capability (Version 1.2 of the Source Control Plug-in API)

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.This group of functions defines the additional functionality included in version 1.2 of the Source Control Plug-in API. Eles fornecem acesso a recursos e recursos de controle do código-fonte mais avançados.They provide access to more advanced source control features and capabilities.

FunçãoFunction DescriçãoDescription
SccBeginBatchSccBeginBatch Inicia uma operação em lote.Starts a batch operation.
SccCreateSubProjectSccCreateSubProject Cria um subprojeto com o nome fornecido em um projeto pai existente.Creates a subproject with the given name under an existing parent project.
SccDirDiffSccDirDiff 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.Shows the differences between the local user's directory specified by a fully qualified path name and the source control database location.
SccDirQueryInfoSccDirQueryInfo Examina uma lista de diretórios totalmente qualificados para seu status atual.Examines a list of fully qualified directories for their current status.
SccEndBatchSccEndBatch Finaliza uma operação em lote.Ends a batch operation.
SccGetParentProjectPathSccGetParentProjectPath Retorna o caminho pai do projeto fornecido (o projeto deve existir).Returns parent path of the given project (the project must exist).
SccIsMultiCheckoutEnabledSccIsMultiCheckoutEnabled Verifica se vários check-outs em um arquivo são permitidos.Checks whether multiple checkouts on a file are allowed.
SccWillCreateSccFileSccWillCreateSccFile Verifica se o plug-in criará MSSCCPRJ. Arquivos SCC.Checks whether the plug-in will create MSSCCPRJ.SCC files.

Funções que dão suporte à funcionalidade avançada (versão 1,3 da API de plug-in de controle do código-fonte)Functions that Support Advanced Capability (Version 1.3 of the Source Control Plug-in API)

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.This group of functions defines the additional functionality included in version 1.3 of the Source Control Plug-in API. Eles fornecem acesso a recursos e recursos de controle do código-fonte mais avançados.They provide access to more advanced source control features and capabilities.

FunçãoFunction DescriçãoDescription
SccAddFilesFromSCCSccAddFilesFromSCC Adiciona uma lista de arquivos do controle do código-fonte ao projeto atual.Adds a list of files from source control to the current project.
SccBackgroundGetSccBackgroundGet Recupera uma lista de arquivos do controle do código-fonte sem uma interface do usuário.Retrieves a list of files from source control without a user interface.
SccEnumChangedFilesSccEnumChangedFiles Recupera uma lista de arquivos no controle do código-fonte que são diferentes dos arquivos locais.Retrieves a list of files in source control that are different from the local files.
SccGetExtendedCapabilitiesSccGetExtendedCapabilities Recupera sinalizadores que especificam funcionalidades estendidas com suporte pelo plug-in de controle do código-fonte.Retrieves flags that specify extended capabilities supported by the source control plug-in.
SccGetUserOptionSccGetUserOption Recupera opções específicas do usuário.Retrieves user-specific options.
SccPopulateDirListSccPopulateDirList Examina uma lista de diretórios e arquivos em um projeto ou projetos que estão sob controle do código-fonte.Examines a list of directories and files in a project or projects that are under source control. Cada diretório e nome de arquivo encontrados é passado para uma função de retorno de chamada.Each directory and file name found is passed to a callback function.
SccQueryChangesSccQueryChanges Examina as alterações de nome feitas em uma lista de arquivos.Examines name changes made to a list of files. Cada nome de arquivo é passado para uma função de retorno de chamada com seu status de alteração.Each file name is passed to a callback function with its change status.

RequisitosRequirements

Cabeçalho: SCC. hHeader: scc.h

(Fornecido no SDK do ambiente, o inclui a pasta, por padrão [unidade] \Program Files\VSIP 8.0 \ EnvSDK\common\inc; também fornecida na pasta VSIP com o exemplo MSSCCI, [unidade] \Arquivos de Files\VSIP \ MSSCCI).(Supplied in the Environment SDK common includes folder, by default [drive] \Program Files\VSIP 8.0\EnvSDK\common\inc; also supplied in the VSIP folder with the MSSCCI sample, [drive] \Program Files\VSIP 8.0\MSSCCI).

Consulte tambémSee also