Remove-TypeData

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

現在のセッションから拡張型を削除します。

構文

Remove-TypeData
      -TypeData <TypeData>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-TypeData
      [-TypeName] <String>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-TypeData
      -Path <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

コマンドレットは Remove-TypeData 、現在のセッションから拡張型データを削除します。 このコマンドレットは、現在のセッションと、現在のセッションで作成されたセッションにのみ作用します。

プロパティとメソッドを PowerShell のオブジェクトに追加するには、コマンドとTypes.ps1xmlファイルでUpdate-TypeData定義します。 Remove-TypeData は、これらの拡張プロパティとメソッドを現在のセッションから削除します。 Remove-TypeData は、ファイルを Types.ps1xml 削除したり、拡張型定義を Types.ps1xml ファイルから削除したりすることはありません。 ファイルのTypes.ps1xml詳細については、「about_Types.ps1xml」を参照してください。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: 指定した型の型データを削除する

次の使用例は、ファイルによって追加された型データや、コマンドレットを使用してTypes.ps1xmlセッションに追加された動的な型データなど、System.Array 型のすべての型データをUpdate-TypeDataセッションから削除します。

Remove-TypeData -TypeName System.Array

例 2: セッションから拡張データ型を削除する

この例では、セッションから拡張型データを削除した場合の影響を示します。 最初 Get-TypeData のデータは、System.DateTime 型の 拡張型データを 取得します。 出力は、PowerShell のすべての System.DateTime オブジェクトに DateTime プロパティが追加されたことを示しています。 このコマンドレットは Get-Date System.DateTime オブジェクトを 返します。 このコマンドでは、ドット表記を使用して、返される System.DateTime オブジェクトの DateTime プロパティの値をGet-Date取得します。

Get-TypeData System.DateTime
(Get-Date).DateTime
Get-TypeData System.DateTime | Remove-TypeData
(Get-Date).DateTime

TypeName        Members
--------        -------
System.DateTime {[DateTime, System.Management.Automation.Runspaces.ScriptPropertyData]}

Friday, January 20, 2012 9:01:00 PM

System.DateTime 型のすべての拡張型データを取得し、そのデータをコマンドレットにRemove-TypeDataパイプして拡張型データを削除する次Get-TypeDataのコマンドレット。 最後Get-Dateのコマンドレットは、System.DateTime 型の拡張型データを削除した結果を示しています。 System.DateTime プロパティが存在しなくなったため、その値を取得するコマンドは何も返しません。

例 3: モジュールの拡張型を削除する

この例では、モジュール オブジェクトのすべての拡張型データを削除します。 パイプを使用してオブジェクトをパイプすると、Remove-TypeDataオブジェクトRemove-TypeData型の名前が取得され、その型のすべてのオブジェクトのすべての型データが削除されます。

Get-Module | Remove-TypeData

例 4: 指定したモジュールから拡張型を削除する

この例では、コマンドレットの Path パラメーターをRemove-TypeData使用して、PSScheduledJob および PSWorkflow モジュールによって追加されるファイルでTypes.ps1xml定義されている拡張型を削除します。 このコマンドは、コマンドレットを使用して追加される動的な型データには Update-TypeData 影響しません。 このコマンドは、モジュールが現在のセッションにインポートされている場合にのみ成功します。

Remove-TypeData -Path "$PSHOME\Modules\PSScheduledJob", "$PSHOME\Modules\PSWorkflow\PSWorkflow.types.ps1xml"

モジュールの詳細については、about_Modulesを参照してください。

例 5: リモート セッションから拡張型を削除する

この例では、リモート セッションから拡張型を削除します。 このコマンドは、コマンドレットを Invoke-Command 使用して、変数内のセッション内のすべての CIM 型の拡張型データを $S 削除します。

Invoke-Command -Session $S {Get-TypeData -TypeName *CIM* | Remove-TypeData}

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

このコマンドレットがセッション拡張型データから削除するファイルの配列を指定します。 このパラメーターは必須です。

1 つ以上 Types.ps1xml のファイルのパスとファイル名を入力します。 ワイルドカードはサポートされていません。 パスを省略した場合、現在のディレクトリが既定の場所になります。

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

-TypeData

このコマンドレットがセッションから削除する型データを指定します。 このパラメーターは必須です。 TypeData オブジェクト (System.Management.Automation.Runspaces.TypeData) を含む変数または TypeData オブジェクトを取得するコマンド (コマンドなど) をGet-TypeData入力します。 TypeData オブジェクトRemove-TypeDataをパイプ処理することもできます。

Type:TypeData
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TypeName

このコマンドレットがすべての拡張型データを削除する型を指定します。 System 名前空間の型に対しては、短い名前を入力します。 それ以外の場合は、完全な型名が必要です。 ワイルドカードはサポートされていません。

パイプ型の名前を次のように Remove-TypeData指定できます。 パイプを使用してオブジェクト Remove-TypeDataの型名を取得し、 Remove-TypeData オブジェクト型のすべての型データを削除します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

TypeData

コマンドレットから 返される TypeData オブジェクトなどの TypeData オブジェクトを Get-TypeData このコマンドレットにパイプできます。

String

型名を含む文字列をこのコマンドレットにパイプできます。 このコマンドレットにオブジェクトをパイプすると、オブジェクトの型名が取得され、オブジェクト型のすべての型データが削除されます。

出力

None

このコマンドレットは、出力を返しません。

メモ

Remove-TypeData では、現在のセッションの拡張型データのみを削除できます。 このコマンドレットは、モジュールに定義されている一方で現在のセッションにインポートされていない拡張型のように、コンピューター上に存在していて現在のセッションに追加されていない拡張型データは削除できません。