ServiceInstaller.Description Propriété

Définition

Espace de noms:

System.ServiceProcess

Assembly:

System.ServiceProcess.dll

Obtient ou définit la description du service.

public:
 property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };

[System.Runtime.InteropServices.ComVisible(false)]
[System.ServiceProcess.ServiceProcessDescription("ServiceInstallerDescription")]
public string Description { get; set; }

[<System.Runtime.InteropServices.ComVisible(false)>]
[<System.ServiceProcess.ServiceProcessDescription("ServiceInstallerDescription")>]
member this.Description : string with get, set

Public Property Description As String

Valeur de propriété

String

Description du service. La valeur par défaut est une chaîne vide ( » « ).

Attributs

ComVisibleAttribute ServiceProcessDescriptionAttribute

Exemples

L’exemple de code suivant définit les propriétés d’installation d’une nouvelle application de service Windows. L’exemple définit le nom du service, ainsi que le nom d’affichage et la description. Après avoir affecté les propriétés d’installation du service, l’exemple ajoute l’objet ServiceInstaller à la Installers collection.

simpleServiceProcessInstaller = new ServiceProcessInstaller();
simpleServiceInstaller = new ServiceInstaller();

// Set the account properties for the service process.
simpleServiceProcessInstaller.Account = ServiceAccount.LocalService;

// Set the installation properties for the service.
// The ServiceInstaller.ServiceName must match the
// ServiceBase.ServiceName set in the service
// implementation that is installed by this installer.
simpleServiceInstaller.ServiceName = "SimpleService";

simpleServiceInstaller.DisplayName = "Simple Service";
simpleServiceInstaller.Description = "A simple service that runs on the local computer.";
simpleServiceInstaller.StartType = ServiceStartMode.Manual;

// Add the installers to the Installer collection.
Installers.Add(simpleServiceInstaller);
Installers.Add(simpleServiceProcessInstaller);

' Start the service.
Protected Overrides Sub OnStart(ByVal args() As String) 
    ' Start a separate thread that does the actual work.
    If workerThread Is Nothing OrElse(workerThread.ThreadState And System.Threading.ThreadState.Unstarted Or System.Threading.ThreadState.Stopped) <> 0 Then
        Trace.WriteLine(DateTime.Now.ToLongTimeString() + " - Starting the service worker thread.", "OnStart")
        
        workerThread = New Thread(New ThreadStart(AddressOf ServiceWorkerMethod))
        workerThread.Start()
    End If
    If Not (workerThread Is Nothing) Then
        Trace.WriteLine(DateTime.Now.ToLongTimeString() + " - Worker thread state = " + workerThread.ThreadState.ToString(), "OnStart")
    End If

End Sub

Remarques

Utilisez la Description propriété pour décrire l’objectif du service installé pour l’utilisateur. L’utilisateur peut afficher la description du service dans les applications qui affichent les détails des services installés.

Par exemple, à l’aide de Windows XP, vous pouvez afficher la description du service avec l’utilitaire de ligne de commande de contrôle de service (Sc.exe) ou afficher la description du service dans le nœud Services de la console gestion de l’ordinateur .

Voir aussi

• ServiceName
• DisplayName