Sdílet prostřednictvím

Export-ModuleMember

Modul:
Microsoft.PowerShell.Core Module

Určuje členy modulu, které se exportují.

Syntaxe

Default (Výchozí) 

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

Description

Rutina Export-ModuleMember určuje členy modulu, které se exportují ze souboru modulu skriptu (.psm1) nebo z dynamického modulu vytvořeného pomocí rutiny New-Module. Členy modulu zahrnují rutiny, funkce, proměnné a aliasy. Tuto rutinu lze použít pouze v souboru modulu skriptu nebo dynamickém modulu.

Pokud modul skriptu neobsahuje příkaz Export-ModuleMember, funkce a aliasy v modulu skriptu se exportují, ale proměnné nejsou. Pokud modul skriptu obsahuje příkazy Export-ModuleMember, exportují se pouze členy zadané v Export-ModuleMember příkazech. Pomocí Export-ModuleMember můžete také potlačit nebo exportovat členy, které modul skriptu importuje z jiných modulů.

Příkaz Export-ModuleMember je nepovinný, ale je osvědčeným postupem. I když příkaz potvrdí výchozí hodnoty, ukazuje záměr autora modulu.

Příklady

Příklad 1: Export funkcí a aliasů v modulu skriptu

Export-ModuleMember -Function * -Alias *

Tento příkaz exportuje všechny funkce a aliasy definované v modulu skriptu.

Příklad 2: Export konkrétních aliasů a funkcí

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

Tento příkaz exportuje tři aliasy a tři funkce definované v modulu skriptu.

Tento formát příkazu můžete použít k určení názvů členů modulu.

Příklad 3: Export žádných členů

Export-ModuleMember

Tento příkaz určuje, že nejsou exportovány žádné členy definované v modulu skriptu.

Tento příkaz zabrání exportu členů modulu, ale neskryje členy. Uživatelé mohou číst a kopírovat členy modulu nebo pomocí operátoru volání (&) vyvolat členy modulu, které nejsou exportovány.

Příklad 4: Export konkrétní proměnné

Export-ModuleMember -Variable increment

Tento příkaz exportuje pouze $increment proměnnou z modulu skriptu. Neexportují se žádní další členové.

Pokud chcete exportovat proměnnou, kromě exportu funkcí v modulu musí příkaz Export-ModuleMember obsahovat názvy všech funkcí a název proměnné.

Příklad 5: Více příkazů pro export

# 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

Tyto příkazy ukazují, jak se v souboru modulu skriptu (Export-ModuleMember) interpretuje více příkazů .psm1.

Tyto příkazy vytvoří tři funkce a jeden alias a pak vyexportují dvě funkce a alias.

Bez příkazů Export-ModuleMember se exportují všechny tři funkce a alias. S příkazy Export-ModuleMember se exportují jenom funkce New-Test a Start-Test a alias STT.

Příklad 6: Export členů v dynamickém modulu

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

Tento příkaz ukazuje, jak používat Export-ModuleMember v dynamickém modulu vytvořeném pomocí rutiny New-Module.

V tomto příkladu se Export-ModuleMember používá k exportu aliasu Hi i funkce SayHello v dynamickém modulu.

Parametry

-Alias

Určuje aliasy, které se exportují ze souboru modulu skriptu. Zadejte názvy aliasů. Jsou povoleny zástupné znaky.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:True
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Cmdlet

Určuje rutiny, které se exportují ze souboru modulu skriptu. Zadejte názvy rutin. Jsou povoleny zástupné znaky.

V souboru modulu skriptu nelze vytvářet rutiny, ale rutiny můžete importovat z binárního modulu do modulu skriptu a znovu je exportovat z modulu skriptu.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:True
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Function

Určuje funkce, které jsou exportovány ze souboru modulu skriptu. Zadejte názvy funkcí. Jsou povoleny zástupné znaky. K Export-ModuleMembermůžete také Export-ModuleMemberřetězce názvů funkcí.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:True
DontShow:False

Sady parametrů

(All)
Position:0
Povinné:False
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Variable

Určuje proměnné, které jsou exportovány ze souboru modulu skriptu. Zadejte názvy proměnných bez znaku dolaru ($). Jsou povoleny zástupné znaky.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:True
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

String

Do této rutiny můžete převést řetězce názvů funkcí.

Výstupy

None

Tento cmdlet nevrátí žádný výstup.

Poznámky

  • Pokud chcete vyloučit člena ze seznamu exportovaných členů, přidejte Export-ModuleMember příkaz, který vypíše všechny ostatní členy, ale vynechá člena, kterého chcete vyloučit.