Export-ModuleMember

  • Referencia
Modul:
Microsoft.PowerShell.Core

Megadja az exportált modultagokat.

Syntax

Export-ModuleMember
      [[-Function] <String[]>]
      [-Cmdlet <String[]>]
      [-Variable <String[]>]
      [-Alias <String[]>]
      [<CommonParameters>]

Description

A Export-ModuleMember parancsmag megadja azokat a modultagokat, amelyeket egy szkriptmodul (.psm1) fájlból vagy a parancsmag használatával New-Module létrehozott dinamikus modulból exportálnak. A modultagok parancsmagokat, függvényeket, változókat és aliasokat tartalmaznak. Ez a parancsmag csak szkriptmodul-fájlban vagy dinamikus modulban használható.

Ha egy szkriptmodul nem tartalmaz parancsot Export-ModuleMember , a szkriptmodulban lévő függvények és aliasok exportálása megtörténik, de a változók nem. Ha egy szkriptmodul parancsokat tartalmaz Export-ModuleMember , a rendszer csak a parancsokban Export-ModuleMember megadott tagokat exportálja. Azt is használhatja Export-ModuleMember , hogy letiltsa vagy exportálja a szkriptmodul által más modulokból importált tagokat.

A Export-ModuleMember parancsok megadása nem kötelező, de ajánlott eljárás. Még akkor is, ha a parancs megerősíti az alapértelmezett értékeket, a modul szerzőjének szándékát mutatja.

Példák

1. példa: Függvények és aliasok exportálása szkriptmodulban

Export-ModuleMember -Function * -Alias *

Ez a parancs exportálja a szkriptmodulban definiált összes függvényt és aliast.

2. példa: Adott aliasok és függvények exportálása

Export-ModuleMember -Function Get-Test, New-Test, Start-Test -Alias gtt, ntt, stt

Ez a parancs exportálja a szkriptmodulban definiált három aliast és három függvényt.

Ezzel a parancsformátummal adhatja meg a modultagok nevét.

3. példa: Tagok exportálása

Export-ModuleMember

Ez a parancs azt határozza meg, hogy a szkriptmodulban definiált tagok nem lesznek exportálva.

Ez a parancs megakadályozza a modultagok exportálását, de nem rejti el a tagokat. A felhasználók elolvashatják és másolhatják a modultagokat, vagy a híváskezelő (&) használatával meghívhatják a nem exportált modultagokat.

4. példa: Adott változó exportálása

Export-ModuleMember -Variable increment

Ez a parancs csak a $increment szkriptmodulból exportálja a változót. A rendszer nem exportál más tagokat.

Ha egy változót szeretne exportálni, a függvények modulban való exportálása mellett a Export-ModuleMember parancsnak tartalmaznia kell az összes függvény nevét és a változó nevét.

5. példa: Több exportálási parancs

# From TestModule.psm1
function New-Test
{
    Write-Output 'I am New-Test function'
}
Export-ModuleMember -Function New-Test

function Validate-Test
{
    Write-Output 'I am Validate-Test function'
}
function Start-Test
{
    Write-Output 'I am Start-Test function'
}
Set-Alias stt Start-Test
Export-ModuleMember -Function Start-Test -Alias stt

Ezek a parancsok bemutatják, Export-ModuleMember hogyan értelmez több parancsot egy szkriptmodul (.psm1) fájl.

Ezek a parancsok három függvényt és egy aliast hoznak létre, majd exportálják a két függvényt és az aliast.

A Export-ModuleMember parancsok nélkül mind a három függvény és az alias exportálva lesz. Export-ModuleMember A parancsokkal csak a New-Test függvényeket és Start-Test az STT aliast exportálja a rendszer.

6. példa: Tagok exportálása dinamikus modulban

New-Module -Script {function SayHello {"Hello!"}; Set-Alias Hi SayHello; Export-ModuleMember -Alias Hi -Function SayHello}

Ez a parancs bemutatja, hogyan használható Export-ModuleMember a parancsmaggal New-Module létrehozott dinamikus modulban.

Ebben a példában Export-ModuleMember az Hi alias és a SayHello függvény dinamikus modulban való exportálására szolgál.

Paraméterek

-Alias

Megadja a szkriptmodul-fájlból exportált aliasokat. Adja meg az aliasneveket. A helyettesítő karakterek használata engedélyezett.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Cmdlet

Megadja a szkriptmodul-fájlból exportált parancsmagokat. Adja meg a parancsmagok nevét. A helyettesítő karakterek használata engedélyezett.

Parancsmagokat nem hozhat létre szkriptmodul-fájlban, de bináris modulból importálhat parancsmagokat egy szkriptmodulba, és újra exportálhatja őket a szkriptmodulból.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Function

Megadja a szkriptmodul-fájlból exportált függvényeket. Adja meg a függvényneveket. A helyettesítő karakterek használata engedélyezett. A pipafüggvények névsztringjei is lehetnek.Export-ModuleMember

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Variable

Megadja a szkriptmodul-fájlból exportált változókat. Adja meg a változóneveket dollárjel ($) nélkül. A helyettesítő karakterek használata engedélyezett.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

Bevitelek

String

Ehhez a parancsmaghoz a függvénynév-sztringeket is beszúrhatja.

Kimenetek

None

Ez a parancsmag nem ad vissza kimenetet.

Jegyzetek

  • Ha ki szeretne zárni egy tagot az exportált tagok listájából, adjon hozzá egy Export-ModuleMember parancsot, amely felsorolja az összes többi tagot, de kihagyja a kizárni kívánt tagot.