GetQVWSSetting Method

Overloads

GetQVWSSetting(Guid)

Declaration

      QVWSSettings GetQVWSSetting(Guid qvwsID)
    

Parameters

Returns

Remarks

Examples

The following code example uses the QMS API to retrieve QVWS settings. It changes the communication port and then saves it. If everything goes well, it prints the original port and then a message when it's done. If anything goes wrong it prints an error message.

The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.

    using System;
using System.Collections.Generic;
using System.Linq;
using QMSAPI;

class Program
{
    static void Main(string[] args)
    {
        try
        {
           // create a QMS API client
           IQMS2 apiClient = new QMS2Client();

           //retrieve a time limited service key
           ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();
           *********************************************************************************************
           //get a list of all QVWSs
           ServiceInfo[] webServers = apiClient.GetServices(ServiceTypes.QlikViewWebServer);

           //get QVWS settings for the first QVWS in the list
           QVWSSettings settings = apiClient.GetQVWSSetting(webServers[0].ID);
           if (settings != null)
           {
                //retrieve and print the current name
                Console.WriteLine("Port before change: " + settings.Port);
                //change the port
                settings.Port = 90;
                //save settings
                apiClient.SetQVWSSetting(settings);
                Console.WriteLine("Settings saved. Port changed.");
           }
        }
        catch(Exception e)
        {
            Console.WriteLine("An error occured: " + e.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

See Also