Refresh .NET article: Create windows service app #11110

dksimpson · 2019-03-06T20:02:16Z

Summary

Task 1409933: https://mseng.visualstudio.com/TechnicalContent/_workitems/edit/1409933/

…efresh-create-service-app

rpetrusha

I've left a large number of comments and suggestions, @dksimpson, but this is a good revision of a very stale article. Thanks for doing it.

rpetrusha · 2019-03-08T21:39:22Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

-3. In **Solution Explorer**, rename **Service1.cs** to **MyNewService.cs**, or rename **Service1.vb** to **MyNewService.vb**.
+2. In the **Service1.cs** window, select any instance of `Service1` in the code, and then choose **Rename** from the shortcut menu. Replace `Service1` with *MyNewService* in the code and then either press **Enter** or select **Apply** in the **Rename: Service1** pop-up window.
+
+3. Select the **Service1.cs [Design]** (or **Service1.vb [Design]**) tab and select **Properties** from the shortcut menu. From the **Properties** window, change the **ServiceName** value to *MyNewService*.


Is this step necessary? Isn't the correct name either provided by creating the project with that name or by earlier rename?

You're correct - if the user renames the file first, VS will then prompt to rename the default Service1 references.

rpetrusha · 2019-03-08T21:40:18Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

+
+3. Select the **Service1.cs [Design]** (or **Service1.vb [Design]**) tab and select **Properties** from the shortcut menu. From the **Properties** window, change the **ServiceName** value to *MyNewService*.
+
+4. In **Solution Explorer**, rename **Service1.cs** to **MyNewService.cs** (or rename **Service1.vb** to **MyNewService.vb**).


Suggested change

4. In **Solution Explorer**, rename **Service1.cs** to **MyNewService.cs** (or rename **Service1.vb** to **MyNewService.vb**).

4. In **Solution Explorer**, rename **Service1.cs** to **MyNewService.cs**, or rename **Service1.vb** to **MyNewService.vb**.

I'd remove the parentheses around the VB variant throughout this article. It implies that VB is secondary, a message we don't really want to convey.

rpetrusha · 2019-03-08T21:43:45Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

+3. In **Solution Explorer**, from the shortcut menu for **MyNewService.cs** (or **MyNewService.vb**), choose **View Code**.

-4. Edit the constructor to define a custom event log:
+4. Edit the `MyNewService()` constructor to define a custom event log:


It would be good before this to add using System.Diagnostics; or Imports System.Diagnostics to the list of imports

VS adds these System.Diagnostics by default in Service1.cs when you create a C# Windows service project. However VS doesn't add any includes for a VB project.

rpetrusha · 2019-03-08T21:46:13Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

+4. Edit the `MyNewService()` constructor to define a custom event log:

   ```csharp
   public MyNewService()


System.Diagnostics. can be removed from lines 71,72, and 74 if the using statement is added.

rpetrusha · 2019-03-08T21:48:20Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md


   [!code-vb[VbRadconService#2](../../../samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbRadconService/VB/MyNewService.vb#2)]

+5. Press **Ctrl**+**S** to save the file.


Why not just select the Save or Save All button on the toolbar?

rpetrusha · 2019-03-08T23:14:53Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

+8. Set the <xref:System.ServiceProcess.ServiceInstaller.StartType%2A> property to <xref:System.ServiceProcess.ServiceStartMode.Automatic> from the dropdown list.

-9. In the designer, choose **serviceProcessInstaller1** for a Visual C# project, or **ServiceProcessInstaller1** for a Visual Basic project. Set the <xref:System.ServiceProcess.ServiceProcessInstaller.Account%2A> property to <xref:System.ServiceProcess.ServiceAccount.LocalSystem>. This causes the service to be installed and to run using the local system account.
+     ![Installer Properties for a Windows service](media/windows-service-installer-properties.png "Windows service installer properties")


This should not be indented. It should be preceded by a paragraph that notes that the Properties window should look like the following figure when the reader is done:

rpetrusha · 2019-03-08T23:34:04Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

+
+1. Select **Program.cs** (or **MyNewService.Designer.vb**), then choose **View Code** from the shortcut menu. In the `Main` method, add an input parameter to pass to the service constructor:

   ```csharp


This code is mostly boilerplate, so it's not obvious what has changed. You might put it in an external file in the dotnet/samples repo and highlight the line with the Main() method. (See https://review.docs.microsoft.com/en-us/engineering/projects/markdig-extensions/codesnippet?branch=master.) This also requires an additional text file named access-by-line.txt; see #10241.

rpetrusha · 2019-03-08T23:40:36Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

   ```

-2. Change the `MyNewService` constructor as follows:
+2. In **MyNewService.cs** (or **MyNewService.cs**), change the `MyNewService` constructor as follows:


Here, it would be useful to highlight the lines that are to be added.

rpetrusha · 2019-03-08T23:41:26Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

   ```

-   This code sets the event source and log name according to the supplied startup parameters, or uses default values if no arguments are supplied.
+   This code sets the event source and log name according to the startup parameters that the user supplies. Or, it uses default values if no arguments are supplied.


Suggested change

This code sets the event source and log name according to the startup parameters that the user supplies. Or, it uses default values if no arguments are supplied.

This code sets the event source and log name according to the startup parameters that the user supplies. If no arguments are supplied, it uses default values.

rpetrusha · 2019-03-08T23:47:23Z

...ows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md

   ```

-   This code modifies the **ImagePath** registry key, which typically contains the full path to the executable for the Windows service, by adding the default parameter values. The quotation marks around the path (and around each individual parameter) are required for the service to start up correctly. To change the startup parameters for this Windows service, users can change the parameters given in the **ImagePath** registry key, although the better way is to change it programmatically and expose the functionality to users in a friendly way (for example, in a management or configuration utility).
+   This code adds the default parameter values to the **ImagePath** registry subkey. Typically, this subkey contains the full path to the executable for the Windows service. For the service to start up correctly, the user must supply quotation marks for the path and each individual parameter. A user can change the parameters in the **ImagePath** registry key to change the startup parameters for the Windows service. However, a better way is to change the key programmatically and expose the functionality in a user-friendly way. For example, in a management or configuration utility.


Suggested change

This code adds the default parameter values to the **ImagePath** registry subkey. Typically, this subkey contains the full path to the executable for the Windows service. For the service to start up correctly, the user must supply quotation marks for the path and each individual parameter. A user can change the parameters in the **ImagePath** registry key to change the startup parameters for the Windows service. However, a better way is to change the key programmatically and expose the functionality in a user-friendly way. For example, in a management or configuration utility.

This code adds the default parameter values to the **ImagePath** named value in the service's registry key. Typically, this value contains the full path to the executable for the Windows service. For the service to start up correctly, the user must supply quotation marks for the path and each individual parameter. A user can change the parameters in the **ImagePath** registry key to change the startup parameters for the Windows service. However, a better way is to change the key programmatically and expose the functionality in a user-friendly way, such as by using a management or configuration utility.

ImagePath is a value, not a key:

…efresh-create-service-app

dksimpson · 2019-03-14T23:18:54Z

Hello @rpetrusha, I've incorporated your updates. Let me know if there's anything else you'd like me to change.

rpetrusha · 2019-03-19T17:29:06Z

Thank you for making the additional changes, @dksimpson. I'll merge your PR now.

dksimpson added 4 commits March 6, 2019 11:59

Refresh .NET article: Create windows service app

7f7fb2a

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

9ce33bd

…efresh-create-service-app

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

2495f3d

…efresh-create-service-app

Edits and cleanup

1f6a5a2

rpetrusha suggested changes Mar 9, 2019

View reviewed changes

dksimpson added 9 commits March 8, 2019 19:35

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

867a7f6

…efresh-create-service-app

VB edits

dfa0385

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

ef7cb59

…efresh-create-service-app

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

94a5a95

…efresh-create-service-app

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

15a9af2

…efresh-create-service-app

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

315ccd6

…efresh-create-service-app

Incorporate tech review comments

31057c7

Merge branch 'master' of https://github.com/dotnet/docs into dotnet-r…

ebac8a6

…efresh-create-service-app

Incorporate tech review comments pt2

7715a03

rpetrusha approved these changes Mar 19, 2019

View reviewed changes

rpetrusha merged commit c0fa021 into dotnet:master Mar 19, 2019

dksimpson mentioned this pull request Mar 27, 2019

Move snippet to samples repo and add line highlighting dotnet/samples#755

Merged


		3. Select the Service1.cs [Design] (or Service1.vb [Design]) tab and select Properties from the shortcut menu. From the Properties window, change the ServiceName value to MyNewService.

		4. In Solution Explorer, rename Service1.cs to MyNewService.cs (or rename Service1.vb to MyNewService.vb).


		[!code-vb[VbRadconService#2](../../../samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbRadconService/VB/MyNewService.vb#2)]

		5. Press Ctrl+S to save the file.


		1. Select Program.cs (or MyNewService.Designer.vb), then choose View Code from the shortcut menu. In the `Main` method, add an input parameter to pass to the service constructor:

		```csharp

	This code sets the event source and log name according to the startup parameters that the user supplies. Or, it uses default values if no arguments are supplied.
	This code sets the event source and log name according to the startup parameters that the user supplies. If no arguments are supplied, it uses default values.

Refresh .NET article: Create windows service app #11110

Refresh .NET article: Create windows service app #11110

Uh oh!

Conversation

dksimpson commented Mar 6, 2019

Summary

Uh oh!

rpetrusha left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dksimpson commented Mar 14, 2019

Uh oh!

rpetrusha commented Mar 19, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants