Uw eigen providermodule maken

In het algemeen moet u de volgende set interfaces implementeren om uw eigen providermodule te maken.

$module::SimpleUsage()

Doel
Geeft eenvoudige modulegebruiksgegevens weer naar STDOUT.

Parameters
Geen

Retourwaarde
Geen

$module::VerboseUsage()

Doel
Geeft gedetailleerde informatie over het gebruik van modules weer voor STDOUT.

Parameters
Geen

Retourwaarde
Geen

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

Doel
Initialiseert een exemplaar van de providermodule.

Parameters

@CommandArguments
Alle @ARGV argumenten die niet worden herkend door ssindex.cmd als algemene argumenten.

Retourwaarde
Een verwijzing die kan worden gebruikt in latere bewerkingen.

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

Doel
Hiermee kan de module de vereiste bronindexeringsgegevens verzamelen voor de map die is opgegeven door de parameter $SourcePath . In de module moet er niet van worden uitgegaan dat deze invoer slechts één keer wordt aangeroepen voor elke objectinstantie, omdat SSIndex deze meerdere keren kan aanroepen voor verschillende paden.

Parameters

$SourcePath
De lokale map met de bron die moet worden geïndexeerd.

$ServerHashReference
Een verwijzing naar een hash met alle vermeldingen uit het opgegeven Srcsrv.ini-bestand.

Retourwaarde
Geen

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

Doel
Biedt de benodigde informatie voor het extraheren van één specifiek bestand uit het broncodebeheersysteem.

Parameters

$LocalFile
Een volledig gekwalificeerde bestandsnaam.

Retourwaarden

$VariableHashReference
Een hash-verwijzing van de variabelen die nodig zijn om de geretourneerde $FileEntry te interpreteren. Ssindex.cmd slaat deze variabelen in de cache op voor elk bronbestand dat wordt gebruikt door één foutopsporingsbestand om de hoeveelheid informatie te verminderen die naar de bronindexstroom wordt geschreven.

$FileEntry
De bestandsvermelding die naar de bronindexstroom moet worden geschreven, zodat SrcSrv dit bestand kan extraheren uit broncodebeheer. De exacte indeling van deze regel is specifiek voor het broncodebeheersysteem.

$TextString= $objref->LongName()

Doel
Biedt een beschrijvende tekenreeks om het broncodebeheersysteem aan de eindgebruiker te identificeren.

Parameters
Geen

Retourwaarde

$TextString
De beschrijvende naam van het broncodebeheersysteem.

@StreamVariableLines=$objref-SourceStreamVariables>()

Doel
Hiermee kan het broncodebeheersysteem specifieke variabelen voor broncodebeheer toevoegen aan de bronstroom voor elk foutopsporingsbestand. De voorbeeldmodules gebruiken deze methode voor het schrijven van de vereiste EXTRACT_CMD en EXTRACT_TARGET variabelen.

Parameters
Geen

Retourwaarde

@StreamVariableLines
De lijst met vermeldingen voor de bronstroomvariabelen.