ServiceBaseとは何？わかりやすく解説 Weblio辞書

索引トップ用語の索引ランキング

ServiceBase イベント

	名前	説明
	Disposed	コンポーネントの Disposed イベントを待機するイベントハンドラを追加します。 ( Component から継承されます。)

参照

ServiceBase クラス

サービスアプリケーションの一部として存在するサービスの基本クラスを提供します。ServiceBase は、新しいサービスクラスの作成時に派生される必要があります。

名前空間: System.ServiceProcess
アセンブリ: System.ServiceProcess (system.serviceprocess.dll 内)
構文

Visual Basic (宣言)

Public Class ServiceBase
    Inherits Component

Visual Basic (使用法)

Dim instance As ServiceBase

public class ServiceBase : Component

C++

public ref class ServiceBase : public
 Component

public class ServiceBase extends Component

JScript

public class ServiceBase extends
 Component

解説

サービスアプリケーションでサービスクラスを定義するときに、ServiceBase から派生します。すべての有効なサービスが、OnStart メソッドと OnStop メソッドをオーバーライドします。追加の機能については、サービス状態の変更に応じた特定の動作で OnPause と OnContinue をオーバーライドできます。

サービスは、ユーザーインターフェイスをサポートしない、長期間実行できる実行可能ファイルです。ログオンしたユーザーアカウントによってはサービスを実行できない場合があります。コンピュータにログオンしているユーザーがいない場合でも、サービスを実行できます。

既定では、サービスはシステムアカウントで実行されます。このシステムアカウントは、管理者アカウントとは異なります。システムアカウントの権限は変更できません。ただし、ServiceProcessInstaller を使用して、サービスを実行するときに使用するユーザーアカウントを指定できます。

実行可能ファイルには、複数のサービスを格納できますが、サービスごとに個別の ServiceInstaller を格納する必要があります。ServiceInstaller インスタンスは、システムにサービスを登録します。また、インストーラは、各サービスをサービスコマンドを記録するために使用できるイベントログに関連付けます。実行可能ファイルの main() 関数は、実行するサービスを定義します。サービスの現在の作業ディレクトリは、実行可能ファイルが置かれているディレクトリではなくシステムディレクトリです。

サービスを開始すると、実行可能ファイルが検索され、実行可能ファイル内にある該当サービスの OnStart メソッドが実行されます。ただし、実行可能ファイルを実行しても、サービスは実行されません。実行可能ファイルは、サービスを読み込むだけです。サービスには、サービスコントロールマネージャを使用してアクセス (開始、停止など) します。

実行可能ファイルは、サービスで最初に Start を呼び出すときに、ServiceBase 派生クラスのコンストラクタを呼び出します。OnStart コマンド処理メソッドは、コンストラクタが実行された直後に呼び出されます。コンストラクタは、サービスが読み込まれた初回にしか実行されません。このため、コンストラクタで実行される処理と OnStart で実行される処理を区別する必要があります。OnStop によって解放できるリソースは、OnStart で作成する必要があります。OnStop がリソースを解放した後にサービスを再開すると、コンストラクタでリソースを作成しても適切に作成されません。

サービスコントロールマネージャ (SCM: Service Control Manager) を使用すると、サービスを対話形式で利用できます。SCM を使用して、Start、Stop、Pause、Continue の各コマンドまたはカスタムコマンドをサービスに渡すことができます。SCM は CanStop の値および CanPauseAndContinue の値を使用して、サービスが Stop、Pause、または Continue のいずれかのコマンドを受け入れるかどうかを判断します。Stop、Pause、および Continue は、対応するプロパティである CanStop または CanPauseAndContinue がサービスクラスで true である場合に限り、SCM のコンテキストメニューで有効になります。有効な場合、コマンドはサービスに渡され、OnStop、OnPause、または OnContinue が呼び出されます。CanStop、CanShutdown、または CanPauseAndContinue が false の場合は、対応するコマンド処理メソッド (OnStop など) を実装している場合でも、そのメソッドは処理されません。

ServiceController クラスを使用すると、ユーザーインターフェイスから SCM が実行する処理をプログラムから実行できます。コンソールで実行するタスクを自動化できます。CanStop、CanShutdown、または CanPauseAndContinue が true で、OnStop などの対応するコマンド処理メソッドを実装していない場合、システムは例外をスローし、コマンドを無視します。

OnStart、OnStop、または ServiceBase の他のメソッドを実装する必要はありません。ただし、サービスの動作は OnStart に記述されているため、最低限、このメンバはオーバーライドされる必要があります。実行可能ファイルの main() 関数のサービス名を設定する必要があります。main() で設定したサービス名は、サービスインストーラの ServiceName プロパティと完全に一致する必要があります。

InstallUtil.exe を使用して、システムにサービスをインストールできます。

メモ
アプリケーションイベントログ以外のログはサービス呼び出しの通知を受け取るように指定できますが、AutoLog プロパティと EventLog プロパティのいずれもカスタムログへの書き込みができません。自動的にログを記録しない場合は、AutoLog を false に設定します。

使用例

簡単なサービス実装を ServiceBase クラスから派生する例を次に示します。このサービスは、Stop、Start、Pause、Continue、カスタムコマンドなどのさまざまなサービスコマンドを処理します。

// Turn on logging to the event log.
#define LOGEVENTS

using System;
using System.IO;
using System.Threading;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Diagnostics;
using System.ServiceProcess;
using System.Text;
using Microsoft.Win32;
using System.Runtime.InteropServices;
using System.Windows.Forms;

namespace ServiceSample
{
    // Define custom commands for the SimpleService.
    public enum SimpleServiceCustomCommands { StopWorker = 128,
 RestartWorker, CheckWorker };
    [StructLayout(LayoutKind.Sequential)]
    public struct SERVICE_STATUS
    {
        public int serviceType;
        public int currentState;
        public int controlsAccepted;
        public int win32ExitCode;
        public int serviceSpecificExitCode;
        public int checkPoint;
        public int waitHint;
    }

    public enum State
    {
        SERVICE_STOPPED = 0x00000001,
        SERVICE_START_PENDING = 0x00000002,
        SERVICE_STOP_PENDING = 0x00000003,
        SERVICE_RUNNING = 0x00000004,
        SERVICE_CONTINUE_PENDING = 0x00000005,
        SERVICE_PAUSE_PENDING = 0x00000006,
        SERVICE_PAUSED = 0x00000007,
    }

    // Define a simple service implementation.
    public class SimpleService : System.ServiceProcess.ServiceBase
    {
        private static int
 userCount = 0;
        private static ManualResetEvent pause
 = new ManualResetEvent(false);

        [DllImport("ADVAPI32.DLL", EntryPoint = "SetServiceStatus")]
        public static extern bool
 SetServiceStatus(
                        IntPtr hServiceStatus,
                        SERVICE_STATUS lpServiceStatus
                        );
        private SERVICE_STATUS myServiceStatus;

        private Thread workerThread = null;

        public SimpleService()
        {
            CanPauseAndContinue = true;
            CanHandleSessionChangeEvent = true;
            ServiceName = "SimpleService";
        }

        static void Main()
        {
#if LOGEVENTS
            EventLog.WriteEntry("SimpleService.Main", DateTime.Now.ToLongTimeString()
 +
                " - Service main method starting...");
#endif

            // Load the service into memory.
            System.ServiceProcess.ServiceBase.Run(new SimpleService());

#if LOGEVENTS
            EventLog.WriteEntry("SimpleService.Main", DateTime.Now.ToLongTimeString()
 +
                " - Service main method exiting...");
#endif

        }

        private void InitializeComponent()
        {
            // Initialize the operating properties for the service.
            this.CanPauseAndContinue = true;
            this.CanShutdown = true;
            this.CanHandleSessionChangeEvent = true;
            this.ServiceName = "SimpleService";
        }

        // Start the service.
        protected override void OnStart(string[]
 args)
        {
            IntPtr handle = this.ServiceHandle;
            myServiceStatus.currentState = (int)State.SERVICE_START_PENDING;
            SetServiceStatus(handle, myServiceStatus);

            // Start a separate thread that does the actual work.

            if ((workerThread == null) ||
                ((workerThread.ThreadState &
                 (System.Threading.ThreadState.Unstarted | System.Threading.ThreadState.Stopped))
 != 0))
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnStart", DateTime.Now.ToLongTimeString()
 +
                    " - Starting the service worker thread.");
#endif

                workerThread = new Thread(new
 ThreadStart(ServiceWorkerMethod));
                workerThread.Start();
            }
            if (workerThread != null)
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnStart", DateTime.Now.ToLongTimeString()
 +
                    " - Worker thread state = " +
                    workerThread.ThreadState.ToString());
#endif
            }
            myServiceStatus.currentState = (int)State.SERVICE_RUNNING;
            SetServiceStatus(handle, myServiceStatus);

        }

        // Stop this service.
        protected override void OnStop()
        {
            // New in .NET Framework version 2.0.
            this.RequestAdditionalTime(4000);
            // Signal the worker thread to exit.
            if ((workerThread != null) &&
 (workerThread.IsAlive))
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnStop", DateTime.Now.ToLongTimeString()
 +
                    " - Stopping the service worker thread.");
#endif
                pause.Reset();
                Thread.Sleep(5000);
                workerThread.Abort();

            }
            if (workerThread != null)
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnStop", DateTime.Now.ToLongTimeString()
 +
                    " - OnStop Worker thread state = " +
                    workerThread.ThreadState.ToString());
#endif
            }
            // Indicate a successful exit.
            this.ExitCode = 0;
        }

        // Pause the service.
        protected override void OnPause()
        {
            // Pause the worker thread.
            if ((workerThread != null) &&
                (workerThread.IsAlive) &&
                ((workerThread.ThreadState &
                 (System.Threading.ThreadState.Suspended | System.Threading.ThreadState.SuspendRequested))
 == 0))
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnPause", DateTime.Now.ToLongTimeString()
 +
                    " - Pausing the service worker thread.");
#endif

                pause.Reset();
                Thread.Sleep(5000);
            }

            if (workerThread != null)
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnPause", DateTime.Now.ToLongTimeString()
 +
                    " OnPause - Worker thread state = " +
                    workerThread.ThreadState.ToString());
#endif
            }
        }

        // Continue a paused service.
        protected override void OnContinue()
        {

            // Signal the worker thread to continue.
            if ((workerThread != null) &&
                ((workerThread.ThreadState &
                 (System.Threading.ThreadState.Suspended | System.Threading.ThreadState.SuspendRequested))
 != 0))
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnContinue", DateTime.Now.ToLongTimeString()
 +
                    " - Resuming the service worker thread.");

#endif
                pause.Set();
            }
            if (workerThread != null)
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnContinue", DateTime.Now.ToLongTimeString()
 +
                    " OnContinue - Worker thread state = " +
                    workerThread.ThreadState.ToString());
#endif
            }
        }

        // Handle a custom command.
        protected override void OnCustomCommand(int
 command)
        {
#if LOGEVENTS
            EventLog.WriteEntry("SimpleService.OnCustomCommand", DateTime.Now.ToLongTimeString()
 +
                " - Custom command received: " +
                command.ToString());
#endif

            // If the custom command is recognized,
            // signal the worker thread appropriately.

            switch (command)
            {
                case (int)SimpleServiceCustomCommands.StopWorker:
                    // Signal the worker thread to terminate.
                    // For this custom command, the main service
                    // continues to run without a worker thread.
                    OnStop();
                    break;

                case (int)SimpleServiceCustomCommands.RestartWorker:

                    // Restart the worker thread if necessary.
                    OnStart(null);
                    break;

                case (int)SimpleServiceCustomCommands.CheckWorker:
#if LOGEVENTS
                    // Log the current worker thread state.
                    EventLog.WriteEntry("SimpleService.OnCustomCommand"
, DateTime.Now.ToLongTimeString()
 +
                        " OnCustomCommand - Worker thread state = " +
                        workerThread.ThreadState.ToString());
#endif

                    break;

                default:
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.OnCustomCommand"
,
                        DateTime.Now.ToLongTimeString());
#endif
                    break;
            }
        }
        // Handle a session change notice
        protected override void OnSessionChange(SessionChangeDescription
 changeDescription)
        {
#if LOGEVENTS
            EventLog.WriteEntry("SimpleService.OnSessionChange", DateTime.Now.ToLongTimeString()
 +
                " - Session change notice received: " +
                changeDescription.Reason.ToString() + "  Session ID: "
 + 
                changeDescription.SessionId.ToString());
#endif

            switch (changeDescription.Reason)
            {
                case SessionChangeReason.SessionLogon:
                    userCount += 1;
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.OnSessionChange",
 
                        DateTime.Now.ToLongTimeString() +
                        " SessionLogon, total users: " +
                        userCount.ToString());
#endif
                    break;

                case SessionChangeReason.SessionLogoff:

                    userCount -= 1;
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.OnSessionChange",
 
                        DateTime.Now.ToLongTimeString() +
                        " SessionLogoff, total users: " +
                        userCount.ToString());
#endif
                    break;
                case SessionChangeReason.RemoteConnect:
                    userCount += 1;
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.OnSessionChange",
 
                        DateTime.Now.ToLongTimeString() +
                        " RemoteConnect, total users: " +
                        userCount.ToString());
#endif
                    break;

                case SessionChangeReason.RemoteDisconnect:

                    userCount -= 1;
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.OnSessionChange",
 
                        DateTime.Now.ToLongTimeString() +
                        " RemoteDisconnect, total users: " +
                        userCount.ToString());
#endif
                    break;
                case SessionChangeReason.SessionLock:
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.OnSessionChange",
 
                        DateTime.Now.ToLongTimeString() + 
                        " SessionLock");
#endif
                    break;

                case SessionChangeReason.SessionUnlock:
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.OnSessionChange",
 
                        DateTime.Now.ToLongTimeString() + 
                        " SessionUnlock");
#endif
                    break;

                default:

                    break;
            }
        }
        // Define a simple method that runs as the worker thread for
 
        // the service.  
        public void ServiceWorkerMethod()
        {
#if LOGEVENTS
            EventLog.WriteEntry("SimpleService.WorkerThread", DateTime.Now.ToLongTimeString()
 +
                " - Starting the service worker thread.");
#endif

            try
            {
                do
                {
                    // Simulate 4 seconds of work.
                    Thread.Sleep(4000);
                    // Block if the service is paused or is shutting
 down.
                    pause.WaitOne();
#if LOGEVENTS
                    EventLog.WriteEntry("SimpleService.WorkerThread", DateTime.Now.ToLongTimeString()
 +
                        " - heartbeat cycle.");
#endif
                }
                while (true);
            }
            catch (ThreadAbortException)
            {
                // Another thread has signalled that this worker
                // thread must terminate.  Typically, this occurs when
                // the main service thread receives a service stop 
                // command.

                // Write a trace line indicating that the worker thread
                // is exiting.  Notice that this simple thread does
                // not have any local objects or data to clean up.
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.WorkerThread", DateTime.Now.ToLongTimeString()
 +
                    " - Thread abort signaled.");
#endif
            }
#if LOGEVENTS

            EventLog.WriteEntry("SimpleService.WorkerThread", DateTime.Now.ToLongTimeString()
 +
                " - Exiting the service worker thread.");
#endif

        }
    }
}

C++

// Turn on the constant for trace output.
#define TRACE

#using <System.ServiceProcess.dll>
#using <System.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::IO;
using namespace System::ServiceProcess;
using namespace System::Threading;
using namespace System::Diagnostics;

// Define custom commands for the SimpleService.
public enum class SimpleServiceCustomCommands
{
    StopWorker = 128,
    RestartWorker, CheckWorker
};


// Define a simple service implementation.
public ref class SimpleService: public
 System::ServiceProcess::ServiceBase
{
private:
    Thread^ workerThread;
    int userCount;
public:
    SimpleService()
    {
        CanPauseAndContinue = true;
        ServiceName = "SimpleService";
        workerThread = nullptr;
        CanHandleSessionChangeEvent = true;
    }

private:

    void InitializeComponent()
    {
        // Initialize the operating properties for the service.
        this->CanPauseAndContinue = true;
        this->CanShutdown = true;
        this->ServiceName = "SimpleService";
        this->CanHandleSessionChangeEvent = true;
    }

    // Start the service.
protected:
    virtual void OnStart( array<String^>^  ) override
    {
        // Start a separate thread that does the actual work.
        if ( (workerThread == nullptr) || ((workerThread->ThreadState
 & (System::Threading::ThreadState::Unstarted | System::Threading::ThreadState::Stopped))
 != (System::Threading::ThreadState)0) )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Starting
 the service worker thread.", "OnStart" );
            workerThread = gcnew Thread( gcnew ThreadStart( this,&SimpleService::ServiceWorkerMethod
 ) );
            workerThread->Start();
        }

        if ( workerThread != nullptr )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Worker
 thread state = " + workerThread->ThreadState.ToString(), "OnStart"
 );
        }
    }

    // Stop this service.
protected:
    virtual void OnStop() override
    {
        // Signal the worker thread to exit.
        if ( (workerThread != nullptr) && (workerThread->IsAlive)
 )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Stopping
 the service worker thread.", "OnStop" );
            workerThread->Abort();

            // Wait up to 500 milliseconds for the thread to terminate.
            workerThread->Join( 500 );
        }

        if ( workerThread != nullptr )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Worker
 thread state = " + workerThread->ThreadState.ToString(), "OnStop"
 );
        }
    }

    // Pause the service.
protected:
    virtual void OnPause() override
    {
        // Pause the worker thread.
        if ( (workerThread != nullptr) && (workerThread->IsAlive)
 && ((workerThread->ThreadState & (System::Threading::ThreadState::Suspended
 | System::Threading::ThreadState::SuspendRequested)) == (System::Threading::ThreadState)0) )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Suspending
 the service worker thread.", "OnPause" );
            workerThread->Suspend();
        }

        if ( workerThread != nullptr )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Worker
 thread state = " + workerThread->ThreadState.ToString(), "OnPause"
 );
        }
    }

    // Continue a paused service.
protected:
    virtual void OnContinue() override
    {
        // Signal the worker thread to continue.
        if ( (workerThread != nullptr) && ((workerThread->ThreadState
 & (System::Threading::ThreadState::Suspended | System::Threading::ThreadState::SuspendRequested))
 != (System::Threading::ThreadState)0) )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Resuming
 the service worker thread.", "OnContinue" );
            workerThread->Resume();
        }

        if ( workerThread != nullptr )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Worker
 thread state = " + workerThread->ThreadState.ToString(), "OnContinue"
 );
        }
    }

    // Handle a custom command.
protected:
    virtual void OnCustomCommand( int command
 ) override
    {
        Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Custom command
 received: " + command, "OnCustomCommand" );

        // If the custom command is recognized,
        // signal the worker thread appropriately.
        switch ( command )
        {
        case (int)SimpleServiceCustomCommands::StopWorker:

            // Signal the worker thread to terminate.
            // For this custom command, the main service
            // continues to run without a worker thread.
            OnStop();
            break;

        case (int)SimpleServiceCustomCommands::RestartWorker:

            // Restart the worker thread if necessary.
            OnStart( nullptr );
            break;

        case (int)SimpleServiceCustomCommands::CheckWorker:

            // Log the current worker thread state.
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Worker
 thread state = " + workerThread->ThreadState.ToString(), "OnCustomCommand"
 );
            break;

        default:
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Unrecognized
 custom command ignored!", "OnCustomCommand" );
            break;
        }
    }
protected:
    virtual void OnSessionChange(SessionChangeDescription changeDescription)
 override
    {
        Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Change description
 received: " 
            + changeDescription.ToString(), "OnSessionChange" );

        switch (changeDescription.Reason)
        {
        case SessionChangeReason::SessionLogon:
            userCount += 1;
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + 
                " SessionLogon, total users: " + 
                userCount.ToString(), "OnSessionChange" );
            break;
        case SessionChangeReason::SessionLogoff:
            userCount -= 1;
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + 
                " SessionLogoff, total users: " + 
                userCount.ToString(), "OnSessionChange" );
            break;
        case SessionChangeReason::RemoteConnect:
            userCount += 1;
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + 
                " RemoteConnect, total users: " + 
                userCount.ToString(), "OnSessionChange" );
            break;
        case SessionChangeReason::RemoteDisconnect:
            userCount -= 1;
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + 
                " RemoteDisconnect, total users: " + 
                userCount.ToString(), "OnSessionChange" );
            break;
        case SessionChangeReason::SessionLock:
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + 
                " SessionLock", "OnSessionChange" );
            break;
        case SessionChangeReason::SessionUnlock:
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + 
                " SessionUnlock", "OnSessionChange" );
            break;

        default:
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + 
                " - Unhandled session change event.", "OnSessionChange"
 );
            break;
        }
    }
    // Define a simple method that runs as the worker thread for 
    // the service.  
public:
    void ServiceWorkerMethod()
    {
        Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Starting the
 service worker thread.", "Worker" );
        try
        {
            for ( ; ;  )
            {

                // Wake up every 10 seconds and write
                // a message to the trace output.
                Thread::Sleep( 10000 );
                Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - heartbeat
 cycle.", "Worker" );
            }
        }
        catch ( ThreadAbortException^ ) 
        {
            // Another thread has signalled that this worker
            // thread must terminate.  Typically, this occurs when
            // the main service thread receives a service stop 
            // command.
            // Write a trace line indicating that the worker thread
            // is exiting.  Notice that this simple thread does
            // not have any local objects or data to clean up.
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Thread
 abort signaled.", "Worker" );
        }

        Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Exiting the
 service worker thread.", "Worker" );
    }
};

int main()
{
    String^ logFile = "C:\\service_log.txt";
    TextWriterTraceListener^ serviceTraceListener = nullptr;

    // Create a log file for trace output.
    // A new file is created each time.  If a
    // previous log file exists, it is overwritten.
    StreamWriter^ myFile = File::CreateText( logFile );

    // Create a new trace listener that writes to the text file,
    // and add it to the collection of trace listeners.
    serviceTraceListener = gcnew TextWriterTraceListener( myFile );
    Trace::Listeners->Add( serviceTraceListener );
    Trace::AutoFlush = true;
    Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Service main method
 starting...", "Main" );

    // Load the service into memory.
    System::ServiceProcess::ServiceBase::Run( gcnew SimpleService );
    Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Service main method
 exiting...", "Main" );

    // Remove and close the trace listener for this service.
    Trace::Listeners->Remove( serviceTraceListener );
    serviceTraceListener->Close();
    serviceTraceListener = nullptr;
    myFile->Close();
}

継承階層

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
      System.ServiceProcess.ServiceBase

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
ServiceBase メンバ
System.ServiceProcess 名前空間
ServiceProcessInstaller
ServiceInstaller

ServiceBase コンストラクタ

ServiceBase クラスの新しいインスタンスを作成します。

名前空間: System.ServiceProcess
アセンブリ: System.ServiceProcess (system.serviceprocess.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New ServiceBase

public ServiceBase ()

C++

public:
ServiceBase ()

public ServiceBase ()

JScript

public function ServiceBase ()

解説

ServiceBase クラスのインスタンスを作成しないでください。代わりに、ServiceBase から派生させて、派生クラスをインスタンス化します。ServiceBase から継承されたクラスのコンストラクタに実装するためには、最低限、コンポーネントで ServiceName を設定する必要があります。その他の特別な処理をコンストラクタで行う必要はありません。ほとんどの初期化は、コンストラクタではなく OnStart で処理する必要があります。コンストラクタで処理すると、サービスが停止してから再開するときに、オブジェクトが再初期化されない場合があります。

派生クラスでコンストラクタをオーバーライドする場合は、コード内で基本クラスのコンストラクタを呼び出します。

ServiceBase コンストラクタは、AutoLog を true に設定します。サービスコントロールマネージャ (SCM) からのサービスの呼び出しを自動的にログに記録しない場合は、AutoLog を false に設定します。

実行可能ファイルにサービスが 1 つだけ含まれている場合は、SCM で Start が選択されるとサービスのコンストラクタが呼び出され、Stop が呼び出されるとデストラクタが実行されます。

実行可能ファイルに複数のサービスが含まれる場合は、1 つのサービスで Start が呼び出されると、実行可能ファイル内のすべてのサービスのコンストラクタが呼び出されますが、開始されるのは指定されたサービスだけです。サービスのデストラクタは、各サービスが個別に停止したときではなく、すべてのサービスが停止したときに一度に実行されます。

メモ
基本クラスのコンストラクタをオーバーライドする場合は、派生クラスのコンストラクタで基本クラスを明示的に呼び出す必要があります。

使用例

ServiceBase から派生したサービスクラスのコンストラクタの例を次に示します。このコード例は、ServiceBase クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

Public Sub New()
    CanPauseAndContinue = True
    CanHandleSessionChangeEvent = True
    ServiceName = "SimpleService"

End Sub 'New

public SimpleService()
{
    CanPauseAndContinue = true;
    CanHandleSessionChangeEvent = true;
    ServiceName = "SimpleService";
}

C++

public:
    SimpleService()
    {
        CanPauseAndContinue = true;
        ServiceName = "SimpleService";
        workerThread = nullptr;
        CanHandleSessionChangeEvent = true;
    }

.NET Framework のセキュリティ

直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
ServiceBase クラス
ServiceBase メンバ
System.ServiceProcess 名前空間
OnStart
AutoLog
Run

ServiceBase フィールド

パブリックフィールドパブリックフィールド

	名前	説明
	MaxNameLength	サービス名の最大サイズを示します。

参照

ServiceBase プロパティ

パブリックプロパティパブリックプロパティ

( プロテクトプロパティも参照)

	名前	説明
	AutoLog	イベントログで、Start、Stop、Pause、Continue の各コマンドをレポートするかどうかを示します。
	CanHandlePowerEvent	サービスで、コンピュータの電源ステータスの変更の通知を処理できるかどうかを示す値を取得または設定します。
	CanHandleSessionChangeEvent	ターミナルサーバーセッションから受信したセッション変更イベントをサービスで処理できるかどうかを示す値を取得または設定します。
	CanPauseAndContinue	サービスを一時中断および再開できるかどうかを示す値を取得または設定します。
	CanShutdown	システムのシャットダウン時に、サービスにそれを通知する必要があるかどうかを示す値を取得または設定します。
	CanStop	サービスを開始した後に停止できるかどうかを示す値を取得または設定します。
	Container	Component を格納している IContainer を取得します。 ( Component から継承されます。)
	EventLog	Start や Stop などのサービスコマンドの呼び出し通知をアプリケーションイベントログに書き込むために使用できるイベントログを取得します。
	ExitCode	サービスの終了コードを取得または設定します。
	ServiceName	システムでサービスを識別するために使用される短い名前を取得または設定します。
	Site	Component の ISite を取得または設定します。 ( Component から継承されます。)

プロテクトプロパティ

	名前	説明
	CanRaiseEvents	コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。 ( Component から継承されます。)
	DesignMode	Component が現在デザインモードかどうかを示す値を取得します。 ( Component から継承されます。)
	Events	Component に結び付けられているイベントハンドラのリストを取得します。 ( Component から継承されます。)
	ServiceHandle	サービスのサービスコントロールハンドルを取得します。

参照

ServiceBase メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	CreateObjRef	リモートオブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
	Dispose	オーバーロードされます。 ServiceBase によって使用されているリソースを破棄します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービスオブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービスオブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	RequestAdditionalTime	保留中の操作について時間の延長を要求します。
	Run	オーバーロードされます。サービスの実行可能ファイルのメインエントリポイントを示します。
	ServiceMainCallback	コマンドハンドラを登録し、サービスを開始します。
	Stop	サービスの実行を停止します。
	ToString	Component の名前を格納している String を返します (存在する場合)。このメソッドはオーバーライドできません。 ( Component から継承されます。)

プロテクトメソッド

	名前	説明
	Dispose	オーバーロードされます。オーバーライドされます。 ServiceBase によって使用されているリソースを破棄します。
	Finalize	Component がガベージコレクションによってクリアされる前に、アンマネージリソースを解放し、その他のクリーンアップ操作を実行します。 ( Component から継承されます。)
	GetService	Component またはその Container で提供されるサービスを表すオブジェクトを返します。 ( Component から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)
	OnContinue	派生クラスに実装されると、OnContinue は、サービスコントロールマネージャ (SCM) によって Continue コマンドがサービスに送信されるときに実行されます。サービスが一時中断してから通常の操作の再開時に実行されるアクションを指定します。
	OnCustomCommand	派生クラスに実装されると、OnCustomCommand は、サービスコントロールマネージャ (SCM) でカスタムコマンドがサービスに渡されるときに、実行されます。パラメータ値が設定されているコマンドの発生時に実行されるアクションを指定します。
	OnPause	派生クラスに実装されると、Pause コマンドがサービスコントロールマネージャ (SCM) によってサービスに送信されるときに実行されます。サービスが一時中断したときに実行されるアクションを指定します。
	OnPowerEvent	派生クラスに実装されると、コンピュータの電源ステータスの変更時に実行されます。これは中断モードのラップトップコンピュータに適用されるもので、システムのシャットダウンとは異なります。
	OnSessionChange	変更イベントがターミナルサーバーセッションから受信された場合に実行します。
	OnShutdown	派生クラスに実装されると、システムがシャットダウンされるときに実行されます。システムがシャットダウンする直前に発生する動作を指定します。
	OnStart	派生クラスに実装されると、Start コマンドがサービスコントロールマネージャ (SCM) によってサービスに送信されるとき、またはオペレーティングシステムが (自動的に起動するサービスのために) 起動するときに実行されます。サービスが開始するときに実行されるアクションを指定します。
	OnStop	派生クラスに実装されると、Stop コマンドがサービスコントロールマネージャ (SCM) によってサービスに送信されるときに実行されます。サービスが実行を停止したときに実行されるアクションを指定します。

参照

ServiceBase メンバ

サービスアプリケーションの一部として存在するサービスの基本クラスを提供します。ServiceBase は、新しいサービスクラスの作成時に派生される必要があります。

ServiceBase データ型で公開されるメンバを以下の表に示します。

パブリックコンストラクタ

	名前	説明
	ServiceBase	ServiceBase クラスの新しいインスタンスを作成します。

パブリックフィールド

	名前	説明
	MaxNameLength	サービス名の最大サイズを示します。

パブリックプロパティ

( プロテクトプロパティも参照)

	名前	説明
	AutoLog	イベントログで、Start、Stop、Pause、Continue の各コマンドをレポートするかどうかを示します。
	CanHandlePowerEvent	サービスで、コンピュータの電源ステータスの変更の通知を処理できるかどうかを示す値を取得または設定します。
	CanHandleSessionChangeEvent	ターミナルサーバーセッションから受信したセッション変更イベントをサービスで処理できるかどうかを示す値を取得または設定します。
	CanPauseAndContinue	サービスを一時中断および再開できるかどうかを示す値を取得または設定します。
	CanShutdown	システムのシャットダウン時に、サービスにそれを通知する必要があるかどうかを示す値を取得または設定します。
	CanStop	サービスを開始した後に停止できるかどうかを示す値を取得または設定します。
	Container	Component を格納している IContainer を取得します。(Component から継承されます。)
	EventLog	Start や Stop などのサービスコマンドの呼び出し通知をアプリケーションイベントログに書き込むために使用できるイベントログを取得します。
	ExitCode	サービスの終了コードを取得または設定します。
	ServiceName	システムでサービスを識別するために使用される短い名前を取得または設定します。
	Site	Component の ISite を取得または設定します。(Component から継承されます。)

プロテクトプロパティ

	名前	説明
	CanRaiseEvents	コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。(Component から継承されます。)
	DesignMode	Component が現在デザインモードかどうかを示す値を取得します。(Component から継承されます。)
	Events	Component に結び付けられているイベントハンドラのリストを取得します。(Component から継承されます。)
	ServiceHandle	サービスのサービスコントロールハンドルを取得します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	CreateObjRef	リモートオブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
	Dispose	オーバーロードされます。 ServiceBase によって使用されているリソースを破棄します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービスオブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービスオブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	RequestAdditionalTime	保留中の操作について時間の延長を要求します。
	Run	オーバーロードされます。サービスの実行可能ファイルのメインエントリポイントを示します。
	ServiceMainCallback	コマンドハンドラを登録し、サービスを開始します。
	Stop	サービスの実行を停止します。
	ToString	Component の名前を格納している String を返します (存在する場合)。このメソッドはオーバーライドできません。 (Component から継承されます。)

プロテクトメソッド

	名前	説明
	Dispose	オーバーロードされます。オーバーライドされます。 ServiceBase によって使用されているリソースを破棄します。
	Finalize	Component がガベージコレクションによってクリアされる前に、アンマネージリソースを解放し、その他のクリーンアップ操作を実行します。 (Component から継承されます。)
	GetService	Component またはその Container で提供されるサービスを表すオブジェクトを返します。 (Component から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)
	OnContinue	派生クラスに実装されると、OnContinue は、サービスコントロールマネージャ (SCM) によって Continue コマンドがサービスに送信されるときに実行されます。サービスが一時中断してから通常の操作の再開時に実行されるアクションを指定します。
	OnCustomCommand	派生クラスに実装されると、OnCustomCommand は、サービスコントロールマネージャ (SCM) でカスタムコマンドがサービスに渡されるときに、実行されます。パラメータ値が設定されているコマンドの発生時に実行されるアクションを指定します。
	OnPause	派生クラスに実装されると、Pause コマンドがサービスコントロールマネージャ (SCM) によってサービスに送信されるときに実行されます。サービスが一時中断したときに実行されるアクションを指定します。
	OnPowerEvent	派生クラスに実装されると、コンピュータの電源ステータスの変更時に実行されます。これは中断モードのラップトップコンピュータに適用されるもので、システムのシャットダウンとは異なります。
	OnSessionChange	変更イベントがターミナルサーバーセッションから受信された場合に実行します。
	OnShutdown	派生クラスに実装されると、システムがシャットダウンされるときに実行されます。システムがシャットダウンする直前に発生する動作を指定します。
	OnStart	派生クラスに実装されると、Start コマンドがサービスコントロールマネージャ (SCM) によってサービスに送信されるとき、またはオペレーティングシステムが (自動的に起動するサービスのために) 起動するときに実行されます。サービスが開始するときに実行されるアクションを指定します。
	OnStop	派生クラスに実装されると、Stop コマンドがサービスコントロールマネージャ (SCM) によってサービスに送信されるときに実行されます。サービスが実行を停止したときに実行されるアクションを指定します。

パブリックイベント

	名前	説明
	Disposed	コンポーネントの Disposed イベントを待機するイベントハンドラを追加します。(Component から継承されます。)

参照

ServiceBaseとは？わかりやすく解説

ServiceBase イベント

関連項目

ServiceBase クラス

ServiceBase コンストラクタ

ServiceBase フィールド

関連項目

ServiceBase プロパティ

関連項目

ServiceBase メソッド

関連項目

ServiceBase メンバ

関連項目

「ServiceBase」の関連用語


	© 2025 Microsoft.All rights reserved.

ServiceBaseとは？ わかりやすく解説

ServiceBase イベント

関連項目

ServiceBase クラス

ServiceBase コンストラクタ

ServiceBase フィールド

関連項目

ServiceBase プロパティ

関連項目

ServiceBase メソッド

関連項目

ServiceBase メンバ

関連項目

急上昇のことば

「ServiceBase」の関連用語

ServiceBaseとは？わかりやすく解説