Przykład Events01

W tym przykładzie pokazano, jak utworzyć polecenie cmdlet umożliwiające użytkownikowi rejestrowanie zdarzeń zgłaszanych przez System.IO.FileSystemWatcher. Za pomocą tego polecenia cmdlet użytkownicy mogą zarejestrować akcję do wykonania po utworzeniu pliku w określonym katalogu. Ten przykład pochodzi z klasy bazowej Microsoft.PowerShell.Commands.ObjectEventRegistrationBase.

Jak utworzyć przykład przy użyciu programu Visual Studio

1. Po zainstalowaniu zestawu Windows PowerShell 2.0 SDK przejdź do folderu Events01. Domyślna lokalizacja to C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0\Samples\sysmgmt\WindowsPowerShell\csharp\Events01.

2. Kliknij dwukrotnie ikonę pliku rozwiązania (.sln). Spowoduje to otwarcie przykładowego projektu w programie Microsoft Visual Studio.

3. W menu Kompilacja wybierz pozycję Build Solution, aby skompilować bibliotekę dla przykładu w domyślnych folderach \bin lub \bin\debug.

Jak uruchomić przykład

1. Utwórz następujący folder modułu:

   [user]\Documents\WindowsPowerShell\Modules\events01

2. Skopiuj plik biblioteki przykładu do folderu modułu.

3. Uruchom program Windows PowerShell.

4. Uruchom następujące polecenie, aby załadować polecenie cmdlet do programu Windows PowerShell:

   Import-Module events01
   

5. Użyj polecenia cmdlet Register-FileSystemEvent, aby zarejestrować akcję, która napisze komunikat podczas tworzenia pliku w katalogu TEMP.

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

6. Utwórz plik w katalogu TEMP i zwróć uwagę, że akcja jest wykonywana (wyświetlany jest komunikat).

Jest to przykładowe dane wyjściowe, które są wynikiem wykonania tych kroków.

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

Wymagania

Ten przykład wymaga programu Windows PowerShell 2.0.

Demonstruje

W tym przykładzie pokazano następujące elementy.

Jak napisać polecenie cmdlet na potrzeby rejestracji zdarzeń

Polecenie cmdlet pochodzi z klasy Microsoft.PowerShell.Commands.ObjectEventRegistrationBase, która zapewnia obsługę parametrów wspólnych dla poleceń cmdlet Register-*Event. Polecenia cmdlet pochodzące z Microsoft.PowerShell.Commands.ObjectEventRegistrationBase muszą definiować tylko określone parametry i przesłaniać metody abstrakcyjne GetSourceObject i GetSourceObjectEventName.

Przykład

W tym przykładzie pokazano, jak zarejestrować zdarzenia zgłaszane przez 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;
        }
    }
}

Zobacz też

• pisanie polecenia cmdlet programu Windows PowerShell