DisplayName Property

ServiceController::DisplayName Property

 

Gets or sets a friendly name for the service.

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

public:
[ServiceProcessDescriptionAttribute("SPDisplayName")]
property String^ DisplayName {
	String^ get();
	void set(String^ value);
}

Property Value

Type: System::String^

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

Exception Condition
ArgumentNullException

The DisplayName is null.

Win32Exception

An error occurred when accessing a system API.

InvalidOperationException

The service was not found.

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

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);
      }
   }
}

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft