Click or drag to resize
IQMSQDSNeedRestart Method
Sets that the QDS needs a restart.

Namespace: PIX.Services.V12
Assembly: 
Syntax
bool QDSNeedRestart(
	Guid qdsID,
	out string reason
)

Parameters

qdsID
Type: SystemGuid
The QDS ID.
reason
Type: SystemString
The reason for the restart.

Return Value

Type: Boolean
The service returns the boolean value True if the operation was performed successfully.
Remarks
The service sets the server to accept that it needs to be restarted. A string named Reason can be sent to the service as part of the call, which is useful for logging purposes.
Security note Security Note

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

Examples
This code example checks if the QDS is set to need a restart and then executes the restart.

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 System.Threading;
 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();

             Guid qdsId = new Guid("67968710-6a84-446d-b759-ceb0cc9d656f"); // The originating QDS ID
             String RestartReason;
             if (apiClient.QDSNeedRestart(out RestartReason, qdsId) == true)    //QDS requires restart if DocFolder changed
             {
                 Console.WriteLine("QDS will be restarted. Reason: " + RestartReason);
                 apiClient.RestartQDS(qdsId);
             }
         }
         catch (Exception ex)
         {
             Console.WriteLine("An exception occurred: " + ex.Message);
         }
         // wait for user to press any key
         Console.ReadLine();
     }
}
See Also