Import-IseSnippet

Mengimpor cuplikan ISE ke dalam sesi saat ini

Sintaks

Import-IseSnippet
      [-Path] <String>
      [-Recurse]
      [<CommonParameters>]
Import-IseSnippet
      [-Recurse]
      -Module <String>
      [-ListAvailable]
      [<CommonParameters>]

Deskripsi

Import-IseSnippet Cmdlet mengimpor "cuplikan" teks yang dapat digunakan kembali dari modul atau direktori ke dalam sesi saat ini. Cuplikan segera tersedia untuk digunakan di Windows PowerShell ISE. Cmdlet ini hanya berfungsi di Windows PowerShell Integrated Scripting Environment (ISE).

Untuk melihat dan menggunakan cuplikan yang diimpor, dari menu Edit ISE Windows PowerShell, klik Mulai Cuplikan atau tekan Ctrl+J.

Cuplikan yang diimpor hanya tersedia dalam sesi saat ini. Untuk mengimpor cuplikan ke semua sesi ISE Windows PowerShell, tambahkan Import-IseSnippet perintah ke profil Windows PowerShell Anda atau salin file cuplikan ke direktori $HOME\Documents\WindowsPowershell\Snippetscuplikan lokal Anda .

Untuk mengimpor cuplikan, cuplikan harus diformat dengan benar dalam cuplikan XML untuk cuplikan ISE Windows PowerShell dan disimpan dalam file Snippet.ps1xml. Untuk membuat cuplikan yang memenuhi syarat, gunakan New-IseSnippet cmdlet . New-IseSnippet membuat <SnippetTitle>.Snippets.ps1xml file di $HOME\Documents\WindowsPowerShell\Snippets direktori. Anda dapat memindahkan atau menyalin cuplikan ke direktori Cuplikan modul Windows PowerShell, atau ke direktori lain.

Get-IseSnippet Cmdlet, yang mendapatkan cuplikan yang dibuat pengguna di direktori cuplikan lokal, tidak mendapatkan cuplikan yang diimpor.

Cmdlet ini diperkenalkan di Windows PowerShell 3.0.

Contoh

Contoh 1: Mengimpor cuplikan dari direktori

Contoh ini mengimpor cuplikan dari direktori ke \\Server01\Public\Snippets dalam sesi saat ini. Ini menggunakan parameter Recurse untuk mendapatkan cuplikan dari semua subdirektori direktori Cuplikan.

Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse

Contoh 2: Mengimpor cuplikan dari modul

Contoh ini mengimpor cuplikan dari modul SnippetModule . Perintah menggunakan parameter ListAvailable untuk mengimpor cuplikan meskipun modul SnippetModule tidak diimpor ke sesi pengguna saat perintah berjalan.

Import-IseSnippet -Module SnippetModule -ListAvailable

Contoh 3: Menemukan cuplikan dalam modul

Contoh ini mendapatkan cuplikan di semua modul yang diinstal dalam variabel lingkungan PSModulePath .

($env:PSModulePath).split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$_.fullname}

Contoh 4: Mengimpor semua cuplikan modul

Contoh ini mengimpor semua cuplikan dari semua modul yang diinstal ke dalam sesi saat ini. Biasanya, Anda tidak perlu menjalankan perintah seperti ini karena modul yang memiliki cuplikan akan menggunakan Import-IseSnippet cmdlet untuk mengimpornya saat modul diimpor.

($env:PSModulePath).split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$psise.CurrentPowerShellTab.Snippets.Load($_)}

Contoh 5: Menyalin semua cuplikan modul

Contoh ini menyalin file cuplikan dari semua modul yang diinstal ke Snippets direktori pengguna saat ini. Tidak seperti cuplikan yang diimpor, yang hanya memengaruhi sesi saat ini, cuplikan yang disalin tersedia di setiap sesi ISE Windows PowerShell.

($env:PSModulePath).split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    Copy-Item -Destination $HOME\Documents\WindowsPowerShell\Snippets

Parameter

-ListAvailable

Menunjukkan bahwa cmdlet ini mendapatkan cuplikan dari modul yang diinstal di komputer, bahkan jika modul tidak diimpor ke sesi saat ini. Jika parameter ini dihilangkan, dan modul yang ditentukan oleh parameter Modul tidak diimpor ke sesi saat ini, upaya untuk mendapatkan cuplikan dari modul gagal.

Parameter ini hanya valid ketika parameter Modul digunakan dalam perintah .

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

-Module

Mengimpor cuplikan dari modul yang ditentukan ke dalam sesi saat ini. Karakter kartubebas tidak didukung.

Parameter ini mengimpor cuplikan dari Snippet.ps1xml file di subdirektori Cuplikan di jalur modul, seperti $HOME\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.

Parameter ini dirancang untuk digunakan oleh penulis modul dalam skrip startup, seperti skrip yang ditentukan dalam kunci ScriptsToProcess dari manifes modul. Cuplikan dalam modul tidak diimpor secara otomatis dengan modul, tetapi Anda dapat menggunakan Import-IseSnippet perintah untuk mengimpornya.

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

-Path

Menentukan jalur ke direktori cuplikan tempat cmdlet ini mengimpor cuplikan.

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

-Recurse

Menunjukkan bahwa cmdlet ini mengimpor cuplikan dari semua subdirektori nilai parameter Path .

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

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

None

Cmdlet ini tidak mengembalikan output.

Catatan

  • Anda tidak dapat menggunakan Get-IseSnippet cmdlet untuk mendapatkan cuplikan yang diimpor. Get-IseSnippet hanya mendapatkan cuplikan $HOME\Documents\WindowsPowerShell\Snippets di direktori.

  • Import-IseSnippetmenggunakan metode statis Muat objek Microsoft.PowerShell.Host.ISE.ISESnippetCollection. Anda juga dapat menggunakan metode Muat cuplikan dalam model objek ISE Windows PowerShell: $psISE.CurrentPowerShellTab.Snippets.Load()

  • New-IseSnippet Cmdlet menyimpan cuplikan baru yang dibuat pengguna dalam file .ps1xml yang tidak ditandatangani. Dengan demikian, Windows PowerShell tidak dapat memuatnya ke dalam sesi di mana kebijakan eksekusi AllSigned atau Restricted. Dalam sesi Terbatas atau AllSigned, Anda dapat membuat, mendapatkan, dan mengimpor cuplikan yang dibuat pengguna yang tidak ditandatangani, tetapi Anda tidak dapat menggunakannya dalam sesi.

    Untuk menggunakan cuplikan yang dibuat pengguna yang tidak ditandatangani yang Import-IseSnippet dikembalikan cmdlet, ubah kebijakan eksekusi, lalu mulai ulang WINDOWS PowerShell ISE.

    Untuk informasi selengkapnya tentang kebijakan eksekusi Windows PowerShell, lihat about_Execution_Policies.