Funkcje interfejsu API wtyczki kontroli źródła

Interfejs API wtyczki kontroli kodu źródłowego udostępnia następujące funkcje, które muszą zostać zaimplementowane przez wtyczkę kontroli źródła zgodnie z tym interfejsem API. Podpisy poszczególnych funkcji oraz semantyka skojarzona z flagami bitów i innymi parametrami zostały szczegółowo opisane w tym odwołaeniu.

Inicjowanie i funkcje housekeeping

Funkcja Opis
SccCloseProject Zamyka projekt.
SccGetCommandOptions Monituje użytkownika o opcje zaawansowane dla danego polecenia.
SccGetVersion Zwraca wersję wtyczki kontroli źródła.
SccInitialize Inicjuje wtyczkę kontroli źródła. Jest on wywoływany raz dla każdego wystąpienia wtyczki.
SccOpenProject Otwiera projekt.
SccSetOption Funkcja ogólna używana do ustawienia szerokiej gamy opcji. Każda opcja rozpoczyna się SCC_OPT_xxx od i ma własny zdefiniowany zestaw wartości.
SccUninitialize Wywoływana raz, gdy wtyczka kontroli źródła musi zostać odpięta.

Podstawowe funkcje kontroli źródła

Funkcja Opis
SccAdd Dodaje tablicę plików określoną przez w pełni kwalifikowane nazwy ścieżek do systemu kontroli źródła.
SccAddFromScc Umożliwia użytkownikowi przeglądanie plików, które znajdują się już w systemie kontroli źródła, a następnie ich część w bieżącym projekcie.
SccCheckin Sprawdza tablicę plików.
SccCheckout Sprawdza tablicę plików.
SccDiff Przedstawia różnice między plikiem użytkownika lokalnego określonym przez w pełni kwalifikowaną nazwę ścieżki a wersją pod kontrolą źródła.
SccGet Pobiera kopię zestawu plików tylko do odczytu.
SccGetEvents Sprawdza stan plików, o które pytał wywołujący (za pośrednictwem SccQueryInfo ).
SccGetProjPath Powoduje, że wtyczka kontroli źródła monituje użytkownika o ścieżkę projektu zrozumiałą dla wtyczki.
SccHistory Przedstawia historię tablicy w pełni kwalifikowanych nazw plików lokalnych.
SccPopulateList Sprawdza listę plików ich bieżącego stanu. Ponadto funkcja używa funkcji do powiadamiania wywołującego, gdy plik nie spełnia pfnPopulate kryteriów dla nCommand .
SccProperties Przedstawia właściwości w pełni kwalifikowanego pliku.
SccQueryInfo Sprawdza listę w pełni kwalifikowanych plików dla ich bieżącego stanu.
SccRemove Usuwa tablicę w pełni kwalifikowanych plików z systemu kontroli źródła.
SccRename Zmienia nazwę danego pliku na nową nazwę w systemie kontroli źródła.
SccRunScc Uzyskuje dostęp do pełnego zakresu funkcji systemu kontroli źródła.
SccUncheckout Cofa wyewidencjonowanie tablicy plików.

Funkcje, które obsługują dodatkową możliwość (wersja 1.2 interfejsu API wtyczki kontroli kodu źródłowego)

Ta grupa funkcji definiuje dodatkowe funkcje zawarte w wersji 1.2 interfejsu API wtyczki kontroli kodu źródłowego. Zapewniają one dostęp do bardziej zaawansowanych funkcji i możliwości kontroli źródła.

Funkcja Opis
SccBeginBatch Uruchamia operację wsadu.
SccCreateSubProject Tworzy podprojekt o podanej nazwie w istniejącym projekcie nadrzędnym.
SccDirDiff Przedstawia różnice między katalogiem użytkownika lokalnego określonym przez w pełni kwalifikowaną nazwę ścieżki i lokalizację bazy danych kontroli źródła.
SccDirQueryInfo Sprawdza listę w pełni kwalifikowanych katalogów dla ich bieżącego stanu.
SccEndBatch Kończy operację wsadu.
SccGetParentProjectPath Zwraca ścieżkę nadrzędną danego projektu (projekt musi istnieć).
SccIsMultiCheckoutEnabled Sprawdza, czy wiele wyewidencjonowań pliku jest dozwolonych.
SccWillCreateSccFile Sprawdza, czy wtyczka utworzy program MSSCCPRJ. Pliki SCC.

Funkcje, które obsługują zaawansowane możliwości (wersja 1.3 interfejsu API wtyczki kontroli kodu źródłowego)

Ta grupa funkcji definiuje dodatkowe funkcje dostępne w wersji 1.3 interfejsu API wtyczki kontroli kodu źródłowego. Zapewniają one dostęp do bardziej zaawansowanych funkcji i możliwości kontroli źródła.

Funkcja Opis
SccAddFilesFromSCC Dodaje listę plików z kontroli źródła do bieżącego projektu.
SccBackgroundGet Pobiera listę plików z kontroli źródła bez interfejsu użytkownika.
SccEnumChangedFiles Pobiera listę plików w kontroli źródła, które różnią się od plików lokalnych.
SccGetExtendedCapabilities Pobiera flagi określające rozszerzone możliwości obsługiwane przez wtyczkę kontroli źródła.
SccGetUserOption Pobiera opcje specyficzne dla użytkownika.
SccPopulateDirList Sprawdza listę katalogów i plików w projekcie lub projektach, które są pod kontrolą źródła. Każdy znaleziony katalog i nazwa pliku są przekazywane do funkcji wywołania zwrotnego.
SccQueryChanges Sprawdza zmiany nazw wprowadzone do listy plików. Każda nazwa pliku jest przekazywana do funkcji wywołania zwrotnego ze stanem zmiany.

Wymagania

Nagłówek: scc.h

(Podany w folderze common includes zestawu SDK środowiska, domyślnie [drive] \Program Files\VSIP 8.0\EnvSDK\common\inc; również podany w folderze VSIP z przykładem MSSCCI ,[drive] \Program Files\VSIP 8.0\MSSCCI).

Zobacz też