How to Create a Visual Basic SMO Project in Visual Studio .NET

This section describes how to build a simple SMO console application.

This example imports namespaces, which enables the program to reference SMO types. The import of the Agent namespace is optional. Use it when you are writing a program that uses SQL Server Agent. The Common namespace is required to establish a secure connection to the instance of SQL Server. The SqlClient namespace is used to process SQL exception errors.

Creating a Visual Basic SMO project in Visual Studio.NET

  1. Start Visual Studio 2015.

  2. On the File menu, click New and then Project. The New Project dialog box appears.

  3. In the Visual Studio Installed pane, navigate to Templates\Visual Basic\Windows and select Console Application.

  4. (Optional) In the Name text box, type the name of the new application.

  5. Click OK to load the Visual Basic console application template.

  6. On the Project menu, select Add Reference. The Reference Manager dialog box appears.

  7. Click Browse to locate the SMO assemblies. Navigate to C:\Program Files\Microsoft SQL Server\130\SDK\Assemblies and then select the following files. These are three of four minimum files that are required to build an SMO application:

    • Microsoft.SqlServer.Management.Sdk.Sfc

    • Microsoft.SqlServer.Smo.dll

    • Microsoft.SqlServer.SqlEnum.dll


    Use the Ctrl key to select more than one file.

  8. Click Add.

  9. Click Browse to locate an additional SMO assembly. Navigate to C:\Program Files (x86)\Microsoft SQL Server\130\SDK\Assemblies and then select the file referenced below. This is the fourth minimum file required to build an SMO application.

    • Microsoft.SqlServer.ConnectionInfo.dll
  10. Click Add.

  11. Add any additional SMO assemblies that are required. For example, if you are specifically programming Service Broker, add the following assemblies:

    • Microsoft.SqlServer.ServiceBrokerEmum.dll
  12. Click OK.

  13. On the View menu, click Code.

  14. In the code, before any declarations, type the following Imports statements to qualify the types in the SMO namespace.

    Imports Microsoft.SqlServer.Management.Smo  
    Imports Microsoft.SqlServer.Management.Common  
  15. SMO has various namespaces under Microsoft.SqlServer.Management.Smo, such as Microsoft.SqlServer.Management.Smo.Agent. Add these namespaces as they are required.

  16. You can now add your SMO code.