GetQVSSettings Method

Overloads

GetQVSSettings(Guid, QVSSettingsScope)

Declaration

      QVSSettings GetQVSSettings(Guid qvsID, QVSSettingsScope scope)
    

Parameters

Returns

Remarks

Examples

The following code example uses the QMS API to retrieve a registered QlikView Server and its logging settings. It changes the log folder and then saves the logging settings. If everything goes well, it prints the original logging folder 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 QMSAPI;

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

            //retrieve a time limited service key
            ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();

            // get a list of QVS services
            List<ServiceInfo> qvsServices = apiClient.GetServices(ServiceTypes.QlikViewServer);
            if (qvsServices.Count > 0)
            {
                // retrieve logging settings for the first QVS in the list
                QVSSettings qvsSettings = apiClient.GetQVSSettings(qvsServices[0].ID, QVSSettingsScope.Logging);
                Console.WriteLine("QVS log folder before change: " + qvsSettings.Logging.Folder);
                // change log folder
                qvsSettings.Logging.Folder = @"\\myshare\logs";
                // save settings
                apiClient.SaveQVSSettings(qvsSettings);
                Console.WriteLine("Settings saved. Log folder changed.");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadKey();
    }
}
  

See Also