Click or drag to resize
IQMSGetAlertText Method
Returns a simple text message describing the current state of the QMS.

Namespace: PIX.Services.V12
Assembly: 
Syntax
string GetAlertText()

Return Value

Type: String
A text message
Remarks
Security note Security Note

Requires membership of local group QlikView Management API.

Examples
The following code example retrieves the alert string from the QMS and prints it if it is not empty.

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

           string alert = apiClient.GetAlertText();
           if(!string.IsNullOrWhiteSpace(alert))
               Console.WriteLine("Alert message from QMS:" + alert);
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
See Also