Egyéni Windows PowerShelles beépülő modul írása
Ez a példa bemutatja, hogyan írhat Windows PowerShell adott parancsmagokat regisztráló beépülő modult.
Az ilyen típusú beépülő modulokkal megadhatja, hogy mely parancsmagokat, szolgáltatókat, típusokat vagy formátumokat kell regisztrálni. A szerelvények összes parancsmagját és szolgáltatóját regisztráló beépülő modul megírásának további információiért lásd: Writing a Windows PowerShell Snap-in(Beépülő modul írása).
Adott parancsmagokat regisztráló Windows PowerShell beépülő modul írása.
Adja hozzá a RunInstallerAttribute attribútumot.
Hozzon létre egy nyilvános osztályt, amely a System.Management.Automation.Custompssnapin osztályból származik.
Ebben a példában az osztály neve "CustomPSSnapinTest".
Adjon hozzá egy nyilvános tulajdonságot a beépülő modul nevéhez (kötelező). A beépülő modulok elnevezésekor ne használja a következő karakterek egyikét:
#
,.
,
(
)
{
}
[
]
&
-
/
\
$
;
:
"
'
<
>
|
?
@
`````*
Ebben a példában a beépülő modul neve "CustomPSSnapInTest".
Adjon hozzá egy nyilvános tulajdonságot a beépülő modul gyártójához (kötelező).
Ebben a példában a szállító a "Microsoft".
Adjon hozzá egy nyilvános tulajdonságot a beépülő modul szállítói erőforrása számára (nem kötelező).
Ebben a példában a szállítói erőforrás a "CustomPSSnapInTest,Microsoft".
Adjon hozzá egy nyilvános tulajdonságot a beépülő modul leírásához (kötelező).
Ebben a példában a leírás a következő: "Ez egy egyéni Windows PowerShell, amely tartalmazza a
Test-HelloWorld
ésTest-CustomSnapinTest
parancsmagokat".Adjon hozzá egy nyilvános tulajdonságot a beépülő modul leírási erőforrása számára (nem kötelező).
Ebben a példában a szállítói erőforrás a következő:
CustomPSSnapInTest, Ez egy egyéni Windows PowerShell beépülő modul, amely tartalmazza a Test-HelloWorld és Test-CustomSnapinTest parancsmagokat".
Adja meg az egyéni beépülő modulhoz tartozó parancsmagokat (nem kötelező) a System.Management.Automation.Runspaces.Cmdletconfigurationentry osztály használatával. Az itt hozzáadott információk közé tartozik a parancsmag neve, a .NET-típusa és a parancsmag súgófájlneve (a parancsmag súgófájlnevének formátumának a következőnek kell lennie:
name.dll-help.xml
).Ez a példa hozzáadja a Test-HelloWorld és TestCustomSnapinTest parancsmagokat.
Adja meg az egyéni beépülő modulhoz tartozó szolgáltatókat (nem kötelező).
Ebben a példában nem határozunk meg szolgáltatókat.
Adja meg az egyéni beépülő modulhoz tartozó típusokat (nem kötelező).
Ez a példa nem ad meg típusokat.
Adja meg az egyéni beépülő modulhoz tartozó formátumokat (nem kötelező).
Ez a példa nem határoz meg formátumokat.
Példa
Ez a példa bemutatja, hogyan írhat egyéni Windows PowerShell, amely a és a Test-HelloWorld
Test-CustomSnapinTest
parancsmagok regisztrálását mutatja be. Vegye figyelembe, hogy ebben a példában a teljes szerelvény tartalmazhat olyan parancsmagokat és szolgáltatókat, amelyek nem lesznek regisztrálva a beépülő modul által.
[RunInstaller(true)]
public class CustomPSSnapinTest : CustomPSSnapIn
{
/// <summary>
/// Creates an instance of CustomPSSnapInTest class.
/// </summary>
public CustomPSSnapinTest()
: base()
{
}
/// <summary>
/// Specify the name of the custom PowerShell snap-in.
/// </summary>
public override string Name
{
get
{
return "CustomPSSnapInTest";
}
}
/// <summary>
/// Specify the vendor for the custom PowerShell snap-in.
/// </summary>
public override string Vendor
{
get
{
return "Microsoft";
}
}
/// <summary>
/// Specify the localization resource information for the vendor.
/// Use the format: resourceBaseName,resourceName.
/// </summary>
public override string VendorResource
{
get
{
return "CustomPSSnapInTest,Microsoft";
}
}
/// <summary>
/// Specify a description of the custom PowerShell snap-in.
/// </summary>
public override string Description
{
get
{
return "This is a custom PowerShell snap-in that includes the Test-HelloWorld and Test-CustomSnapinTest cmdlets.";
}
}
/// <summary>
/// Specify the localization resource information for the description.
/// Use the format: resourceBaseName,Description.
/// </summary>
public override string DescriptionResource
{
get
{
return "CustomPSSnapInTest,This is a custom PowerShell snap-in that includes the Test-HelloWorld and Test-CustomSnapinTest cmdlets.";
}
}
/// <summary>
/// Specify the cmdlets that belong to this custom PowerShell snap-in.
/// </summary>
private Collection<CmdletConfigurationEntry> _cmdlets;
public override Collection<CmdletConfigurationEntry> Cmdlets
{
get
{
if (_cmdlets == null)
{
_cmdlets = new Collection<CmdletConfigurationEntry>();
_cmdlets.Add(new CmdletConfigurationEntry("test-customsnapintest", typeof(TestCustomSnapinTest), "TestCmdletHelp.dll-help.xml"));
_cmdlets.Add(new CmdletConfigurationEntry("test-helloworld", typeof(TestHelloWorld), "HelloWorldHelp.dll-help.xml"));
}
return _cmdlets;
}
}
/// <summary>
/// Specify the providers that belong to this custom PowerShell snap-in.
/// </summary>
private Collection<ProviderConfigurationEntry> _providers;
public override Collection<ProviderConfigurationEntry> Providers
{
get
{
if (_providers == null)
{
_providers = new Collection<ProviderConfigurationEntry>();
}
return _providers;
}
}
/// <summary>
/// Specify the types that belong to this custom PowerShell snap-in.
/// </summary>
private Collection<TypeConfigurationEntry> _types;
public override Collection<TypeConfigurationEntry> Types
{
get
{
if (_types == null)
{
_types = new Collection<TypeConfigurationEntry>();
}
return _types;
}
}
/// <summary>
/// Specify the formats that belong to this custom PowerShell snap-in.
/// </summary>
private Collection<FormatConfigurationEntry> _formats;
public override Collection<FormatConfigurationEntry> Formats
{
get
{
if (_formats == null)
{
_formats = new Collection<FormatConfigurationEntry>();
}
return _formats;
}
}
}
További információ a beépülő modulok regisztrálásról: How to Register Cmdlets, Providers, and Host Applications (Parancsmagok, szolgáltatók és gazdaalkalmazások regisztrálása) a Windows PowerShell Programozói útmutatóban.
Lásd még:
Parancsmagok, szolgáltatók és gazdaalkalmazások regisztrálása