共用方式為


建立您自己的提供者模組

一般而言,若要建立您自己的提供者模組,您必須實作下列一組介面。

$module::SimpleUsage ()

目的
顯示 STDOUT 的簡單模組使用資訊。

參數

傳回值

$module::VerboseUsage ()

目的
顯示 STDOUT 的深入模組使用資訊。

參數

傳回值

$objref = $module::new (@CommandArguments )

目的
初始化提供者模組的實例。

參數

@CommandArguments
ssindex.cmd 無法辨識為一般引數的所有 @ARGV 引數。

傳回值
可用於後續作業的參考。

$objref- >GatherFileInformation ($SourcePath$ServerHashReference)

目的
可讓模組收集 $SourcePath 參數所指定目錄所需的來源索引資訊。 模組不應該假設每個物件實例只呼叫一次此專案,SSIndex 可能會針對不同的路徑多次呼叫它。

參數

$SourcePath
包含要編制索引之來源的本機目錄。

$ServerHashReference
雜湊的參考,其中包含指定之Srcsrv.ini檔案中的所有專案。

傳回值

($VariableHashReference$FileEntry) =$objref-GetFileInfo> ($LocalFile)

目的
提供從原始檔控制系統擷取單一特定檔案的必要資訊。

參數

$LocalFile
完整檔案名。

傳回值

$VariableHashReference
解譯傳回 $FileEntry所需變數的雜湊參考。 Ssindex.cmd 會針對單一偵錯檔案所使用的每個來源檔案快取這些變數,以減少寫入來源索引資料流程的資訊量。

$FileEntry
要寫入來源索引資料流程的檔案專案,可讓 SrcSrv 從原始檔控制擷取此檔案。 此行的確切格式專屬於原始檔控制系統。

$TextString= $objref-LongName > ()

目的
提供描述性字串,以向使用者識別原始檔控制系統。

參數

傳回值

$TextString
原始檔控制系統的描述性名稱。

@StreamVariableLines=$objref-SourceStreamVariables > ()

目的
可讓原始檔控制系統將原始檔控制特定變數新增至每個偵錯檔案的來來源資料流。 範例模組會使用這個方法來撰寫必要的EXTRACT_CMD和EXTRACT_TARGET變數。

參數

傳回值

@StreamVariableLines
來來源資料流變數的專案清單。