Skapa en egen providermodul

För att skapa en egen providermodul måste du implementera följande uppsättning gränssnitt.

$module::SimpleUsage()

Avsikt
Visar enkel modulanvändningsinformation för STDOUT.

Parametrar
Ingen

Returvärde
Ingen

$module::VerboseUsage()

Avsikt
Visar detaljerad information om modulanvändning för STDOUT.

Parametrar
Ingen

Returvärde
Ingen

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

Avsikt
Initierar en instans av providermodulen.

Parametrar

@CommandArguments
Alla @ARGV argument som inte identifieras av ssindex.cmd som allmänna argument.

Returvärde
En referens som kan användas i senare åtgärder.

$objref->GatherFileInformation($SourcePath,$ServerHashReference)

Avsikt
Gör att modulen kan samla in nödvändig källindexeringsinformation för katalogen som anges av parametern $SourcePath . Modulen bör inte förutsätta att den här posten bara anropas en gång för varje objektinstans eftersom SSIndex kan anropa den flera gånger för olika sökvägar.

Parametrar

$SourcePath
Den lokala katalogen som innehåller den källa som ska indexeras.

$ServerHashReference
En referens till en hash som innehåller alla poster från den angivna Srcsrv.ini filen.

Returvärde
Ingen

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

Avsikt
Innehåller nödvändig information för att extrahera en enda, specifik fil från källkontrollsystemet.

Parameterar

$LocalFile
Ett fullständigt kvalificerat filnamn.

Returnera värden

$VariableHashReference
En hashreferens för de variabler som behövs för att tolka den returnerade $FileEntry. Ssindex.cmd cachelagrar dessa variabler för varje källfil som används av en enda felsökningsfil för att minska mängden information som skrivs till källindexströmmen.

$FileEntry
Filposten som ska skrivas till källindexströmmen så att SrcSrv kan extrahera filen från källkontrollen. Det exakta formatet för den här raden är specifikt för källkontrollsystemet.

$TextString= $objref->LongName()

Avsikt
Tillhandahåller en beskrivande sträng för att identifiera källkontrollsystemet för slutanvändaren.

Parametrar
Ingen

Returvärde

$TextString
Källkontrollsystemets beskrivande namn.

@StreamVariableLines=$objref-SourceStreamVariables>()

Avsikt
Gör att källkontrollsystemet kan lägga till källkontrollspecifika variabler i källströmmen för varje felsökningsfil. Exempelmodulerna använder den här metoden för att skriva nödvändiga EXTRACT_CMD och EXTRACT_TARGET variabler.

Parametrar
Ingen

Returvärde

@StreamVariableLines
Listan över poster för källflödesvariablerna.