Ukázka Events01

Tato ukázka ukazuje, jak vytvořit rutinu, která uživateli umožňuje zaregistrovat se k událostem, které jsou vyvolány System.IO.FileSystemWatcher. Pomocí této rutiny můžou uživatelé zaregistrovat akci, která se spustí při vytvoření souboru v určitém adresáři. Tato ukázka je odvozena od Microsoft.PowerShell.Commands.ObjectEventRegistrationBase základní třídy.

Postup sestavení ukázky pomocí sady Visual Studio

1. S nainstalovanou sadou Windows PowerShell 2.0 SDK přejděte do složky Events01. Výchozí umístění je C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\Events01.

2. Poklikejte na ikonu souboru řešení (.sln). Tím se otevře ukázkový projekt v sadě Microsoft Visual Studio.

3. V nabídce Sestavení vyberte Sestavit řešení a sestavte knihovnu ukázky ve výchozích \bin nebo \bin\debug složkách.

Spuštění ukázky

1. Vytvořte následující složku modulu:

   [user]\Documents\WindowsPowerShell\Modules\events01

2. Zkopírujte soubor knihovny ukázky do složky modulu.

3. Spusťte Windows PowerShell.

4. Spuštěním následujícího příkazu načtěte rutinu do Windows PowerShellu:

   Import-Module events01
   

5. Pomocí rutiny Register-FileSystemEvent zaregistrujte akci, která při vytvoření souboru v adresáři TEMP zapíše zprávu.

   Register-FileSystemEvent $Env:TEMP Created -Filter "*.txt" -Action { Write-Host "A file was created in the TEMP directory" }
   

6. Vytvořte soubor v adresáři TEMP a všimněte si, že se akce spustí (zobrazí se zpráva).

Toto je ukázkový výstup, který výsledkem bude následující postup.

Id              Name            State      HasMoreData     Location             Command
--              ----            -----      -----------     --------             -------
1               26932870-d3b... NotStarted False                                 Write-Host "A f...

Set-Content $Env:TEMP\test.txt "This is a test file"

A file was created in the TEMP directory

Požadavky

Tato ukázka vyžaduje Prostředí Windows PowerShell 2.0.

Demonstruje

Tato ukázka ukazuje následující:

Jak napsat rutinu pro registraci událostí

Rutina je odvozena z třídy Microsoft.PowerShell.Commands.ObjectEventRegistrationBase, která poskytuje podporu parametrů běžných pro rutiny Register-*Event. Rutiny odvozené z Microsoft.PowerShell.Commands.ObjectEventRegistrationBase stačí definovat jejich konkrétní parametry a přepsat GetSourceObject a GetSourceObjectEventName abstraktní metody.

Příklad

Tato ukázka ukazuje, jak zaregistrovat události vyvolané System.IO.FileSystemWatcher.

namespace Sample
{
    using System;
    using System.IO;
    using System.Management.Automation;
    using System.Management.Automation.Runspaces;
    using Microsoft.PowerShell.Commands;

    [Cmdlet(VerbsLifecycle.Register, "FileSystemEvent")]
    public class RegisterObjectEventCommand : ObjectEventRegistrationBase
    {
        /// <summary>The FileSystemWatcher that exposes the events.</summary>
        private FileSystemWatcher fileSystemWatcher = new FileSystemWatcher();

        /// <summary>Name of the event to which the cmdlet registers.</summary>
        private string eventName = null;

        /// <summary>
        /// Gets or sets the path that will be monitored by the FileSystemWatcher.
        /// </summary>
        [Parameter(Mandatory = true, Position = 0)]
        public string Path
        {
            get
            {
                return this.fileSystemWatcher.Path;
            }

            set
            {
                this.fileSystemWatcher.Path = value;
            }
        }

        /// <summary>
        /// Gets or sets the name of the event to which the cmdlet registers.
        /// <para>
        /// Currently System.IO.FileSystemWatcher exposes 6 events: Changed, Created,
        /// Deleted, Disposed, Error, and Renamed. Check the documentation of
        /// FileSystemWatcher for details on each event.
        /// </para>
        /// </summary>
        [Parameter(Mandatory = true, Position = 1)]
        public string EventName
        {
            get
            {
                return this.eventName;
            }

            set
            {
                this.eventName = value;
            }
        }

        /// <summary>
        /// Gets or sets the filter that will be user by the FileSystemWatcher.
        /// </summary>
        [Parameter(Mandatory = false)]
        public string Filter
        {
            get
            {
                return this.fileSystemWatcher.Filter;
            }

            set
            {
                this.fileSystemWatcher.Filter = value;
            }
        }

        /// <summary>
        /// Derived classes must implement this method to return the object that generates
        /// the events to be monitored.
        /// </summary>
        /// <returns> This sample returns an instance of System.IO.FileSystemWatcher</returns>
        protected override object GetSourceObject()
        {
            return this.fileSystemWatcher;
        }

        /// <summary>
        /// Derived classes must implement this method to return the name of the event to
        /// be monitored. This event must be exposed by the input object.
        /// </summary>
        /// <returns> This sample returns the event specified by the user with the -EventName parameter.</returns>
        protected override string GetSourceObjectEventName()
        {
            return this.eventName;
        }
    }
}

Viz také

• psaní rutiny Prostředí Windows PowerShell