Funciones de API de complemento de control de código fuente
La API del complemento de control de código fuente proporciona las siguientes funciones, que debe implementar el complemento de control de código fuente de acuerdo con esta API. Las firmas de cada función y la semántica asociadas a las marcas de bits y otros parámetros se describen en detalle en esta referencia.
Funciones de inicialización y limpieza
| Función | Descripción |
|---|---|
| SccCloseProject | Cierra un proyecto. |
| SccGetCommandOptions | Solicita al usuario opciones avanzadas para el comando especificado. |
| SccGetVersion | Devuelve la versión del complemento de control de código fuente. |
| SccInitialize | Inicializa el complemento de control de código fuente. Se llama una vez para cada instancia del complemento. |
| SccOpenProject | Abre un proyecto. |
| SccSetOption | Función genérica que se usa para establecer una amplia variedad de opciones. Cada opción comienza con SCC_OPT_xxx y tiene su propio conjunto definido de valores. |
| SccUninitialize | Se llama a una vez cuando es necesario desconectar un complemento de control de código fuente. |
Funciones principales de control de código fuente
| Función | Descripción |
|---|---|
| SccAdd | Agrega una matriz de archivos especificados por nombres de ruta de acceso completos al sistema de control de código fuente. |
| SccAddFromScc | Permite al usuario buscar archivos que ya están en el sistema de control de código fuente y, a continuación, convertir esos archivos en parte del proyecto actual. |
| SccCheckin | Comprueba en una matriz de archivos. |
| SccCheckout | Extrae una matriz de archivos. |
| SccDiff | Muestra las diferencias entre el archivo del usuario local especificado por un nombre de ruta de acceso completo y la versión bajo el control de código fuente. |
| SccGet | Recupera una copia de solo lectura de un conjunto de archivos. |
| SccGetEvents | Comprueba el estado de los archivos que el autor de la llamada ha preguntado (a través de SccQueryInfo). |
| SccGetProjPath | Hace que el complemento de control de código fuente solicite al usuario una ruta de acceso del proyecto que sea significativa para el complemento. |
| SccHistory | Muestra el historial de una matriz de nombres de archivo locales completos. |
| SccPopulateList | Examina la lista de archivos para su estado actual. Además, usa la pfnPopulate función para notificar al autor de la llamada cuando un archivo no coincide con los criterios de nCommand. |
| SccProperties | Muestra las propiedades de un archivo completo. |
| SccQueryInfo | Examina una lista de archivos completos para su estado actual. |
| SccRemove | Quita la matriz de archivos completos del sistema de control de código fuente. |
| SccRename | Cambia el nombre del archivo especificado a un nuevo nombre en el sistema de control de código fuente. |
| SccRunScc | Obtiene acceso a toda la gama de características del sistema de control de código fuente. |
| SccUncheckout | Deshace una desprotección de una matriz de archivos. |
Funciones que admiten funcionalidad adicional (versión 1.2 de la API del complemento de control de código fuente)
Este grupo de funciones define la funcionalidad adicional incluida en la versión 1.2 de la API del complemento de control de código fuente. Proporcionan acceso a funcionalidades y características de control de código fuente más avanzadas.
| Función | Descripción |
|---|---|
| SccBeginBatch | Inicia una operación por lotes. |
| SccCreateSubProject | Crea un subproyecto con el nombre especificado en un proyecto primario existente. |
| SccDirDiff | Muestra las diferencias entre el directorio del usuario local especificado por un nombre de ruta de acceso completo y la ubicación de la base de datos del control de código fuente. |
| SccDirQueryInfo | Examina una lista de directorios completos para su estado actual. |
| SccEndBatch | Finaliza una operación por lotes. |
| SccGetParentProjectPath | Devuelve la ruta de acceso primaria del proyecto especificado (el proyecto debe existir). |
| SccIsMultiCheckoutEnabled | Comprueba si se permiten varias desprotecciones en un archivo. |
| SccWillCreateSccFile | Comprueba si el complemento creará MSSCCPRJ. Archivos SCC. |
Funciones que admiten la funcionalidad avanzada (versión 1.3 de la API del complemento de control de código fuente)
Este grupo de funciones define la funcionalidad adicional incluida en la versión 1.3 de la API del complemento de control de código fuente. Proporcionan acceso a funcionalidades y características de control de código fuente más avanzadas.
| Función | Descripción |
|---|---|
| SccAddFilesFromSCC | Agrega una lista de archivos del control de código fuente al proyecto actual. |
| SccBackgroundGet | Recupera una lista de archivos del control de código fuente sin una interfaz de usuario. |
| SccEnumChangedFiles | Recupera una lista de archivos en el control de código fuente que son diferentes de los archivos locales. |
| SccGetExtendedCapabilities | Recupera marcas que especifican funcionalidades extendidas compatibles con el complemento de control de código fuente. |
| SccGetUserOption | Recupera opciones específicas del usuario. |
| SccPopulateDirList | Examina una lista de directorios y archivos en un proyecto o proyectos que están bajo control de código fuente. Cada directorio y nombre de archivo encontrado se pasan a una función de devolución de llamada. |
| SccQueryChanges | Examina los cambios de nombre realizados en una lista de archivos. Cada nombre de archivo se pasa a una función de devolución de llamada con su estado de cambio. |
Requisitos
Encabezado: scc.h
(Se proporciona en la carpeta de inclusión común del SDK de entorno, de forma predeterminada [unidad]\Archivos de programa\VSIP 8.0\EnvSDK\common\inc; también se proporciona en la carpeta VSIP con el ejemplo MSSCCI, [unidad]\Archivos de programa\VSIP 8.0\MSSCCI).