Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ServiceBase Members

Provides a base class for a service that will exist as part of a service application. ServiceBase must be derived from when creating a new service class.

The ServiceBase type exposes the following members.

  NameDescription
Public method ServiceBase Creates a new instance of the ServiceBase class.
Top

  NameDescription
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose Overloaded. Disposes of the resources used by the ServiceBase.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone Overloaded.
Protected method OnContinue When implemented in a derived class, OnContinue runs when a Continue command is sent to the service by the Service Control Manager (SCM). Specifies actions to take when a service resumes normal functioning after being paused.
Protected method OnCustomCommand When implemented in a derived class, OnCustomCommand executes when the Service Control Manager (SCM) passes a custom command to the service. Specifies actions to take when a command with the specified parameter value occurs.
Protected method OnPause When implemented in a derived class, executes when a Pause command is sent to the service by the Service Control Manager (SCM). Specifies actions to take when a service pauses.
Protected method OnPowerEvent When implemented in a derived class, executes when the computer's power status has changed. This applies to laptop computers when they go into suspended mode, which is not the same as a system shutdown.
Protected method OnSessionChange Executes when a change event is received from a Terminal Server session.
Protected method OnShutdown When implemented in a derived class, executes when the system is shutting down. Specifies what should occur immediately prior to the system shutting down.
Protected method OnStart When implemented in a derived class, executes when a Start command is sent to the service by the Service Control Manager (SCM) or when the operating system starts (for a service that starts automatically). Specifies actions to take when the service starts.
Protected method OnStop When implemented in a derived class, executes when a Stop command is sent to the service by the Service Control Manager (SCM). Specifies actions to take when a service stops running.
Public method RequestAdditionalTime Requests additional time for a pending operation.
Public method Static member Run Overloaded. Provides the main entry point for a service executable.
Public method ServiceMainCallback Infrastructure. Registers the command handler and starts the service.
Public method Stop Stops the executing service.
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Top

  NameDescription
Public field Static member MaxNameLength Indicates the maximum size for a service name.
Top

  NameDescription
Public property AutoLog Indicates whether to report Start, Stop, Pause, and Continue commands in the event log.
Public property CanHandlePowerEvent Gets or sets a value indicating whether the service can handle notifications of computer power status changes.
Public property CanHandleSessionChangeEvent Gets or sets a value that indicates whether the service can handle session change events received from a Terminal Server session.
Public property CanPauseAndContinue Gets or sets a value indicating whether the service can be paused and resumed.
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property CanShutdown Gets or sets a value indicating whether the service should be notified when the system is shutting down.
Public property CanStop Gets or sets a value indicating whether the service can be stopped once it has started.
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public property EventLog Gets an event log you can use to write notification of service command calls, such as Start and Stop, to the Application event log.
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property ExitCode Gets or sets the exit code for the service.
Protected property ServiceHandle Gets the service control handle for the service.
Public property ServiceName Gets or sets the short name used to identify the service to the system.
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Top

  NameDescription
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

Community Additions

ADD
Show:
© 2015 Microsoft