原始檔控制外掛程式 API 函式

原始檔控制外掛程式 API 提供下列函式,這些函式必須由原始檔控制外掛程式根據此 API 來執行。 這項參考會詳細說明每個函式的簽章,以及與位旗標和其他參數相關聯的語法。

初始化和維護功能

函式 描述
SccCloseProject 關閉專案。
SccGetCommandOptions 提示使用者提供指定命令的 advanced 選項。
SccGetVersion 傳回原始檔控制外掛程式的版本。
SccInitialize 初始化原始檔控制外掛程式。 它會針對外掛程式的每個實例呼叫一次。
SccOpenProject 開啟專案。
SccSetOption 用來設定各種不同選項的泛型函數。 每個選項的開頭都 SCC_OPT_xxx 是,而且有自己的定義值集合。
SccUninitialize 當原始檔控制外掛程式需要插即用時呼叫一次。

核心原始檔控制功能

函式 描述
SccAdd 將完整路徑名稱所指定的檔案陣列加入至原始檔控制系統。
SccAddFromScc 允許使用者流覽已在原始檔控制系統中的檔案,然後將這些檔案設為目前專案的一部分。
SccCheckin 簽入檔案的陣列。
SccCheckout 簽出檔案的陣列。
SccDiff 顯示以完整路徑名稱和原始檔控制下的版本指定的本機使用者檔案之間的差異。
SccGet 抓取一組檔案的唯讀複本。
SccGetEvents 透過) 檢查呼叫者要求 (的檔案狀態 SccQueryInfo
SccGetProjPath 導致原始檔控制外掛程式提示使用者輸入對外掛程式有意義的專案路徑。
SccHistory 顯示完整本機檔案名陣列的歷程記錄。
SccPopulateList 檢查檔案清單中的目前狀態。 此外,當檔案不 pfnPopulate 符合的準則時,也會使用函式來通知呼叫端 nCommand
SccProperties 顯示完整檔案的屬性。
SccQueryInfo 檢查目前狀態的完整檔案清單。
SccRemove 從原始檔控制系統移除完整檔案的陣列。
SccRename 將指定的檔案重新命名為原始檔控制系統中的新名稱。
SccRunScc 存取原始檔控制系統的各種功能。
SccUncheckout 復原檔陣列的簽出。

支援其他功能的函式 (版本1.2 的原始檔控制外掛程式 API)

這組函式會定義原始檔控制外掛程式 API 1.2 版中包含的其他功能。 它們可讓您存取更先進的原始檔控制功能。

函式 描述
SccBeginBatch 啟動批次作業。
SccCreateSubProject 在現有的父專案下建立具有指定名稱的子專案。
SccDirDiff 顯示完整路徑名稱和原始檔控制資料庫位置所指定的本機使用者目錄之間的差異。
SccDirQueryInfo 檢查完整目錄清單中的目前狀態。
SccEndBatch 結束批次作業。
SccGetParentProjectPath 傳回指定專案的父路徑 (專案必須存在) 。
SccIsMultiCheckoutEnabled 檢查是否允許在檔案上進行多次簽出。
SccWillCreateSccFile 檢查外掛程式是否會建立 MSSCCPRJ.SCC。SCC 檔。

支援 Advanced 功能的函式 (1.3 版的原始檔控制外掛程式 API)

這組函式會定義原始檔控制外掛程式 API 1.3 版中包含的其他功能。 它們可讓您存取更先進的原始檔控制功能。

函式 描述
SccAddFilesFromSCC 將檔案清單從原始檔控制加入至目前的專案。
SccBackgroundGet 從沒有使用者介面的原始檔控制中取出檔案清單。
SccEnumChangedFiles 抓取原始檔控制中不同于本機檔案的檔案清單。
SccGetExtendedCapabilities 抓取旗標,這些旗標會指定原始檔控制外掛程式所支援的擴充功能。
SccGetUserOption 抓取使用者特定的選項。
SccPopulateDirList 檢查位於原始檔控制下的專案或專案中的目錄和檔案清單。 每個找到的目錄和檔案名都會傳遞至回呼函式。
SccQueryChanges 檢查對檔案清單所做的名稱變更。 每個檔案名都會傳遞至具有其變更狀態的回撥函數。

規格需求

標頭: scc。h

依預設,環境 SDK common include 資料夾中提供的 ([磁片磁碟機] \Program Files\VSIP 8.0 \ EnvSDK\common\inc;此外,也會在具有 MSSCCI 範例的 VSIP 資料夾中提供 [磁片磁碟機] \Program Files\VSIP 8.0 \ MSSCCI) 。

另請參閱