Skip to main content Skip to complementary content

FindTask Method

Overloads

FindTask(Guid, TaskType, String)

Finds a single task given its name.

FindTask(Guid, TaskType, String)

Finds a single task given its name.

Declaration

      TaskInfo FindTask(Guid qdsId, TaskType taskType, string name)
    

Parameters

Type Name Description
System.Guid qdsId

The id of the QDS to search.

TaskType taskType

The type of the task to look for.

System.String name

The exact name of the task to look for.

Returns

Type Description
TaskInfo

The task, if found.

Remarks

security

Requires membership of local group QlikView EDX.

Examples

The following code example retrieves matching task and prints some information about it.

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

           //A known QDS id
           Guid qdsId = new Guid("5ac16136-f00b-47c4-8099-23ff7f178423");

           //Get a task with a known name
           TaskInfo taskInfo = apiClient.FindTask(qdsId, TaskType.ExternalProgramTask, "ExtGenerateGlobalReport");

           if (taskInfo != null) {
               //Print information about the task.
               Console.WriteLine(String.Format("Name:{0}\tID:{1}\tEnabled:{2}", taskInfo.Name, taskInfo.ID, taskInfo.Enabled ? "Yes" : "No"));
           }
        }
        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!

Join the Analytics Modernization Program

Remove banner from view

Modernize without compromising your valuable QlikView apps with the Analytics Modernization Program. Click here for more information or reach out: ampquestions@qlik.com