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
cmdlet Import-IseSnippet
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 Windows PowerShell ISE Edit, 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 perintah Import-IseSnippet
ke profil Windows PowerShell Anda atau salin file cuplikan ke direktori cuplikan lokal Anda $HOME\Documents\WindowsPowerShell\Snippets
.
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 cmdlet New-IseSnippet
.
New-IseSnippet
membuat file <SnippetTitle>.Snippets.ps1xml
di direktori $HOME\Documents\WindowsPowerShell\Snippets
. Anda dapat memindahkan atau menyalin cuplikan ke direktori Cuplikan modul Windows PowerShell, atau ke direktori lain.
cmdlet Get-IseSnippet
, 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 \\Server01\Public\Snippets
ke 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 di 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 cmdlet Import-IseSnippet
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 direktori Snippets
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 .
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Module
Mengimpor cuplikan dari modul yang ditentukan ke dalam sesi saat ini. Karakter kartubebas tidak didukung.
Parameter ini mengimpor cuplikan dari file Snippet.ps1xml
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 ScriptsToProcess kunci manifes modul. Cuplikan dalam modul tidak diimpor secara otomatis dengan modul, tetapi Anda dapat menggunakan perintah Import-IseSnippet
untuk mengimpornya.
Jenis: | String |
Position: | Named |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Path
Menentukan jalur ke direktori cuplikan tempat cmdlet ini mengimpor cuplikan.
Jenis: | String |
Position: | 1 |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | False |
Terima karakter wildcard: | True |
-Recurse
Menunjukkan bahwa cmdlet ini mengimpor cuplikan dari semua subdirektori nilai parameter Jalur.
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
Input
None
Anda tidak dapat menyalurkan objek ke cmdlet ini.
Output
None
Cmdlet ini tidak mengembalikan output.
Catatan
Anda tidak dapat menggunakan cmdlet
Get-IseSnippet
untuk mendapatkan cuplikan yang diimpor.Get-IseSnippet
hanya mendapatkan cuplikan di direktori$HOME\Documents\WindowsPowerShell\Snippets
.Import-IseSnippet
menggunakan metode statis Loadobjek Microsoft.PowerShell.Host.ISE.ISESnippetCollection. Anda juga dapat menggunakan metode cuplikan Load dalam model objek ISE Windows PowerShell:$psISE.CurrentPowerShellTab.Snippets.Load()
Cmdlet
New-IseSnippet
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 Terbatas. 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 dikembalikan cmdlet
Import-IseSnippet
, ubah kebijakan eksekusi, lalu mulai ulang Windows PowerShell ISE.Untuk informasi selengkapnya tentang kebijakan eksekusi Windows PowerShell, lihat about_Execution_Policies.