Click or drag to resize
IQMSGetQDSSettings Method
Retrieves the current settings for the QlikView Distribution service with the specified ID.

Namespace: PIX.Services.V12
Assembly: 
Syntax
QDSSettings GetQDSSettings(
	Guid qdsID,
	QDSSettingsScope scope
)

Parameters

qdsID
Type: SystemGuid
The ID of the service.
scope
Type: PIX.QMSAPI.DataObjects.EnumsQDSSettingsScope
The scope of the settings to retrieve.

Return Value

Type: QDSSettings
The current settings for the QlikView Distributioun service
Remarks
The scope parameter indicates which parts of the returned object that will be populated with data.
Security note Security Note

Requires membership of local groups QlikView Management API and QlikView Administrator.

Examples
The following example retrieves a list of QlikView Distribution Services and prints out some of their settings.

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

C#
 using System;
 using System.Collections.Generic;
 using System.Linq;
 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 QlikView Distribution services
             List<ServiceInfo> qdsServices = apiClient.GetServices(ServiceTypes.QlikViewDistributionService);

             //Loops through all services 
             foreach(ServiceInfo info in qdsServices) 
             {                            
                Console.WriteLine(string.Format("{0}", info.Name));
                Console.WriteLine("".PadLeft(info.Name.Length, '='));

                //Gets the General settings for the current service and print information abput the folders used.
                QDSSettings qdsSettings = apiClient.GetQDSSettings(info.ID, QDSSettingsScope.General);
                if(qdsSettings != null)
                {
                    Console.WriteLine("Folders:");
                    qdsSettings.General.SourceFolders.ForEach(folder=>Console.WriteLine("\t" + folder.General.Path));   

                    Console.WriteLine("\nApplicationDataFolder:\n\t" + qdsSettings.General.ApplicationDataFolder);
                }
                Console.WriteLine("\n\n");
             }
         }
         catch (Exception ex)
         {
             Console.WriteLine("An exception occurred: " + ex.Message);
         }
         // wait for user to press any key
         Console.ReadLine();
     }
}
See Also