Export-ModuleMember

Export-ModuleMember [[-関数] <string[]>] [-エイリアス <string[]>] [-Cmdlet <string[]>] [-変数 <string[]>] [<CommonParameters>]

C:\PS>Export-ModuleMember -function * -alias *

説明
-----------
このコマンドは、スクリプト モジュールで定義されたエイリアスを、スクリプト モジュールで定義された関数と共にエクスポートします

既定でエクスポートされないエイリアスをエクスポートするには、関数も明示的に指定する必要があります。そうしない場合、エイリアスのみがエクスポートされます。

C:\PS>Export-ModuleMember -function Get-Test, New-Test, Start-Test -alias gtt, ntt, stt

説明
-----------
このコマンドは、スクリプト モジュールで定義された 3 つのエイリアスおよび 3 つの関数をエクスポートします。

このコマンド形式を使用してモジュール メンバー名を指定できます。

C:\PS>Export-ModuleMember

説明
-----------
このコマンドは、スクリプト モジュールで定義されたメンバーをエクスポートしないことを指定します。

このコマンドを実行すると、モジュール メンバーのエクスポートが防止されますが、これらメンバーが見えなくなるわけではありません。ユーザーは、モジュール メンバーを読み取ってコピーすることも、呼び出し演算子 (&) を使用して、エクスポートされないモジュール メンバーを呼び出すこともできます。

C:\PS>Export-ModuleMember -variable increment

説明
-----------
このコマンドは、スクリプト モジュールから $increment 変数のみをエクスポートします。他のメンバーはエクスポートされません。

モジュール内の関数をエクスポートするだけでなく、変数のエクスポートも実行するには、エクスポートするすべての関数の名前と変数の名前を Export-ModuleMember コマンドに含める必要があります。

C:\PS># From TestModule.psm1

function new-test 
    { <function code> }
export-modulemember -function new-test

function validate-test 
    { <function code> }

function start-test 
    { <function code> }
set-alias stt start-test
export-modulemember -function *-test -alias stt

説明
-----------
これらのコマンドは、複数の Export-ModuleMember コマンドをスクリプト モジュール (.psm1) ファイルで解釈する方法を示しています。

これらのコマンドは、3 つの関数および 1 つのエイリアスを作成した後、2 つの関数およびエイリアスをエクスポートします。

Export-ModuleMember コマンドを使用しない場合、3 つすべての関数がエクスポートされますが、エイリアスはエクスポートされません。Export-ModuleMember コマンドを使用した場合、Get-Test 関数と Start-Test 関数、および STT エイリアスのみがエクスポートされます。

C:\PS>new-module -script {function SayHello {"Hello!"}; set-alias Hi SayHello; Export-ModuleMember -alias Hi -function SayHello}

説明
-----------
このコマンドは、Export-ModuleMember を、New-Module コマンドレットを使用して作成された動的モジュールで使用する方法を示しています。

この例では、Export-ModuleMember を使用して動的モジュールの "Hi" エイリアスおよび "SayHello" 関数を両方ともエクスポートします。

C:\PS>function export
{
    param (
        [parameter(mandatory=$true)] [validateset("function","variable")] $type,
        [parameter(mandatory=$true)] $name,
        [parameter(mandatory=$true)] $value
    )
    if ($type -eq "function")
    {
        Set-item "function:script:$name" $value
        Export-ModuleMember $name
    }
    else
    {
        Set-Variable -scope Script $name $value
        Export-ModuleMember -variable $name
    }
} 

export function New-Test 
{
  ...
}


function helper
{
  ...
}

export variable interval 0
$interval = 2

説明
-----------
この例には、Export という関数が含まれています。この関数は、関数の宣言または変数の作成を行った後で、その関数または変数用の Export-ModuleMember コマンドを記述します。これにより、関数または変数の宣言とエクスポートを 1 つのコマンドで実行することが可能になります。

Export 関数を使用するには、スクリプト モジュールにこの関数を含めます。関数をエクスポートするには、Function キーワードの前に「Export」と入力します。

変数をエクスポートするには、次の形式で変数を宣言し、変数の値を設定します。

    export variable <variable-name> <value>

この例のコマンドは正しい形式を示しています。この例では、New-Test 関数と $Interval 変数のみがエクスポートされます。