C# client

The C# client is compatible with .NET Framework version 4.0 and above.

Overview

To use our C# API to start or stop tests onto NeoLoad, use our DLLs as explained in Create the C# Runtime API client.

First instantiate a RuntimeAPIClient providing a URL and API key.

Then call method GetStatus() to get the current status of NeoLoad, method StartTest() to start a test, method StopTest() to stop a test, method add AddVirtualUsers() to add Virtual Users or method StopVirtualUsers() to stop Virtual Users.

Configure the project

In a Visual Studio project, it is necessary to include the DLL files available either:

• In the NuGet website
• In the NeoLoad installation directory:
  • in the <install-dir>\api\Runtime API Client\Csharp folder
  • in the <install-dir>\api\Common\Csharp folder

• To configure the project with DLLs from NuGet

1. Open the project.
2. Open the Solution Explorer.
3. Find the References node in the project tree.
4. Click right and choose Manage NuGet Packages....
5. In the Search field, type: "neotys runtime".
6. Select dependency name: "NeotysRestRuntimeAPI".
7. Click the Install button.

• To configure the project with DLLs from the NeoLoad installation directory

1. Open the project.
2. Open the Solution Explorer.
3. Find the References node in the project tree.
4. Right click and choose Add Reference.
5. Click on Browse then Browse....
6. Locate and choose the Neotys Runtime API DLL file: NeotysRuntimeAPI.dll.

   Note: Make sure the NeotysRuntimeAPI.xml file is in the same directory to allow method descriptions when calling API methods.

7. Click OK.

Home