QVSNeedRestart Method

Overloads

Sets that the QVS needs a restart.

QVSNeedRestart(Guid, out String)

Sets that the QVS needs a restart.

Declaration

      bool QVSNeedRestart(Guid qvsID, out string reason)

Parameters

Type	Name	Description
System.Guid	qvsID	The QVS ID.
System.String	reason	The reason for the restart.

Returns

Type	Description
System.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

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

Examples

This code example checks if the QVS 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.

    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();

            Guid qvsId = new Guid("e07c145f-7606-4161-b986-b4288650e3b7"); // The originating QVS ID
            String RestartReason;
            if (apiClient.QVSNeedRestart(out RestartReason, qvsId) == true)    //QVS requires restart if DocFolder changed
            {
                Console.WriteLine("QVS will be restarted. Reason: " + RestartReason);
                apiClient.RestartQVS(qvsId);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here