ServiceController.DisplayName Property

Reference

Definition

Namespace:: System.ServiceProcess

Assembly:: System.ServiceProcess.ServiceController.dll

Assembly:: System.ServiceProcess.dll

Package:: System.ServiceProcess.ServiceController v10.0.0-preview.1.25080.5

Source:: ServiceController.cs

Source:: ServiceController.cs

Source:: ServiceController.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a friendly name for the service.

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

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

public string DisplayName { get; set; }

public string DisplayName { get; }

[System.ServiceProcess.ServiceProcessDescription("SPDisplayName")]
public string DisplayName { get; set; }

member this.DisplayName : string with get, set

member this.DisplayName : string

[<System.ServiceProcess.ServiceProcessDescription("SPDisplayName")>]
member this.DisplayName : string with get, set

Public Property DisplayName As String

Public ReadOnly Property DisplayName As String

Property Value

String

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

Attributes: ServiceProcessDescriptionAttribute

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.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)

Share via