This documentation is archived and is not being maintained.

ServiceController.DisplayName Property

Gets or sets a friendly name for the service.

Namespace: System.ServiceProcess
Assembly: System.ServiceProcess (in system.serviceprocess.dll)

'Declaration
Public Property DisplayName As String
'Usage
Dim instance As ServiceController
Dim value As String

value = instance.DisplayName

instance.DisplayName = value
/** @property */
public String get_DisplayName ()

/** @property */
public void set_DisplayName (String value)

public function get DisplayName () : String

public function set DisplayName (value : String)

Not applicable.

Property Value

The friendly name of the service, which can be used to identify the service.

Exception typeCondition

ArgumentNullException

The DisplayName is a null reference (Nothing in Visual Basic).

Win32Exception

An error occurred when accessing a system API.

You can set the DisplayName to an empty string (""), but setting the property to a null reference (Nothing in Visual Basic) throws an exception.

The following example uses the ServiceController class to display the set of services that are dependent on the Event Log service.


Dim sc As New ServiceController("Event Log")
Dim scServices As ServiceController() = sc.DependentServices

' Display the list of services dependent on the Event Log service.
If scServices.Length = 0 Then
   Console.WriteLine("There are no services dependent on {0}", sc.ServiceName)
Else
   Console.WriteLine("Services dependent on {0}:", sc.ServiceName)
   
   Dim scTemp As ServiceController
   For Each scTemp In  scServices
      Console.WriteLine(" {0}", scTemp.DisplayName)
   Next scTemp
End If


ServiceController sc = new ServiceController("Event Log");
ServiceController scServices[] = sc.get_DependentServices();
// Display the list of services dependent on the Event Log service.
if (scServices.get_Length() == 0) {
    Console.WriteLine("There are no services dependent on {0}",
        sc.get_ServiceName());
}
else {
    Console.WriteLine("Services dependent on {0}:", 
        sc.get_ServiceName());
    ServiceController scTemp = new ServiceController();
    for  (int iCtr = 0; iCtr < scServices.get_Length(); iCtr++) {
        scTemp = scServices[iCtr];
        Console.WriteLine(" {0}", scTemp.get_DisplayName());
    }
}

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: