ServiceController.DisplayName Property

Definition

Namespace:

System.ServiceProcess

Assembly:

System.ServiceProcess.ServiceController.dll

Package:

System.ServiceProcess.ServiceController v9.0.0-rc.2.24473.5

Gets or sets a friendly name for the service.

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

public string DisplayName { get; set; }

member this.DisplayName : string with get, set

Public Property DisplayName As String

Property Value

String

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

Exceptions

ArgumentNullException

The DisplayName is null.

Win32Exception

An error occurred when accessing a system API.

InvalidOperationException

The service was not found.

Examples

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

ServiceController^ sc = gcnew ServiceController(  "Event Log" );
array<ServiceController^>^scServices = nullptr;
if ( sc )
{
   scServices = sc->DependentServices;
}

if ( sc && scServices )
{
   // Display the list of services dependent on the Event Log service.
   if ( scServices->Length == 0 )
   {
      Console::WriteLine(  "There are no services dependent on {0}", sc->ServiceName );
   }
   else
   {
      Console::WriteLine(  "Services dependent on {0}:", sc->ServiceName );
      for each (ServiceController^ scTemp in scServices)
      {
         Console::WriteLine(" {0}", scTemp->DisplayName);
      }
   }
}

ServiceController sc =  new ServiceController("Event Log");
ServiceController[] scServices = sc.DependentServices;

// Display the list of services dependent on the Event Log service.
if (scServices.Length == 0)
{
   Console.WriteLine("There are no services dependent on {0}",
                      sc.ServiceName);
}
else
{
   Console.WriteLine("Services dependent on {0}:",
                      sc.ServiceName);

   foreach (ServiceController scTemp in scServices)
   {
      Console.WriteLine(" {0}", scTemp.DisplayName);
   }
}

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

Remarks

You can set the DisplayName to an empty string (""), but setting the property to null throws an exception.