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 każdej funkcji i semantyki skojarzone z flagami bitów i innymi parametrami zostały szczegółowo opisane w tej dokumentacji.
Funkcje inicjowania i utrzymywania domu
| Function | 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 wywoływany raz dla każdego wystąpienia wtyczki. |
| SccOpenProject | Otwiera projekt. |
| SccSetOption | Funkcja ogólna używana do ustawiania szerokiej gamy opcji. Każda opcja rozpoczyna się od SCC_OPT_xxx i ma własny zdefiniowany zestaw wartości. |
| SccUninitialize | Wywoływane raz, gdy wtyczka kontroli źródła musi być odłączona. |
Podstawowe funkcje kontroli źródła
| Function | opis |
|---|---|
| SccAdd | Dodaje tablicę plików określonych 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 udostępnij te pliki jako część bieżącego projektu. |
| SccCheckin | Sprawdza tablicę plików. |
| SccCheckout | Sprawdza tablicę plików. |
| SccDiff | Pokazuje różnice między plikiem użytkownika lokalnego określonym przez w pełni kwalifikowaną nazwę ścieżki i wersję pod kontrolą źródła. |
| SccGet | Pobiera kopię tylko do odczytu zestawu plików. |
| SccGetEvents | Sprawdza stan plików, o które zapytał obiekt wywołujący (za pośrednictwem metody SccQueryInfo). |
| SccGetProjPath | Powoduje, że wtyczka kontroli źródła wyświetla użytkownikowi monit o ścieżkę projektu zrozumiałą dla wtyczki. |
| SccHistory | Przedstawia historię tablicy w pełni kwalifikowanych lokalnych nazw plików. |
| SccPopulateList | Sprawdza listę plików pod kątem ich bieżącego stanu. Ponadto funkcja używa pfnPopulate funkcji do powiadamiania obiekt wywołujący, gdy plik nie jest zgodny z kryteriami .nCommand |
| SccProperties | Przedstawia właściwości w pełni kwalifikowanego pliku. |
| SccQueryInfo | Sprawdza listę w pełni kwalifikowanych plików pod kątem 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 wyewidencjonowania tablicy plików. |
Funkcje, które obsługują dodatkowe możliwości (wersja 1.2 interfejsu API wtyczki kontroli źródła)
Ta grupa funkcji definiuje dodatkowe funkcje zawarte w wersji 1.2 interfejsu API wtyczki kontroli źródła. Zapewniają one dostęp do bardziej zaawansowanych funkcji i możliwości kontroli źródła.
| Function | opis |
|---|---|
| SccBeginBatch | Uruchamia operację wsadową. |
| SccCreateSubProject | Tworzy podprojekt o podanej nazwie w istniejącym projekcie nadrzędnym. |
| SccDirDiff | Pokazuje 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 pod kątem ich bieżącego stanu. |
| SccEndBatch | Kończy operację wsadową. |
| SccGetParentProjectPath | Zwraca ścieżkę nadrzędną danego projektu (projekt musi istnieć). |
| SccIsMultiCheckoutEnabled | Sprawdza, czy w pliku jest dozwolonych wiele wyewidencjonowania. |
| SccWillCreateSccFile | Sprawdza, czy wtyczka utworzy 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 zawarte 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.
| Function | 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 na liście plików. Każda nazwa pliku jest przekazywana do funkcji wywołania zwrotnego ze stanem zmiany. |
Wymagania
Nagłówek: scc.h
(Dostarczane w zestawie SDK środowiska wspólne zawiera folder dołączany domyślnie [dysk]\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).