Click or drag to resize
IQMSFindTask Method
Finds a single task given its name.

Namespace: PIX.Services.V12
Assembly: 
Syntax
TaskInfo FindTask(
	Guid qdsId,
	TaskType taskType,
	string name
)

Parameters

qdsId
Type: SystemGuid
The id of the QDS to search.
taskType
Type: PIX.QMSAPI.DataObjectsTaskType
The type of the task to look for.
name
Type: SystemString
The exact name of the task to look for.

Return Value

Type: TaskInfo
The task, if found.
Remarks
Security note Security Note

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.

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

           //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();
    }
}
See Also