Skip to main content Skip to complementary content

GetCategories Method

Overloads

GetCategories(CategoriesScope)

Returns all categories matching the given scope.

GetCategories(CategoriesScope)

Returns all categories matching the given scope.

Declaration

      List<Category> GetCategories(CategoriesScope scope)
    

Parameters

Type Name Description
CategoriesScope scope

The scope of the categories to return.

Returns

Type Description
System.Collections.Generic.List<Category>

A list of categories.

Remarks

security

Requires membership of local group QlikView Management API.

Examples

The following code example retrieves and prints the currently used categories.

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

           //Retrieves all categories currently assigned to at least one task.
           List<Category> categories = apiClient.GetCategories(CategoriesScope.Used);

           Console.WriteLine("Used categories:");
           categories.ForEach(category => Console.WriteLine(category.Name));
        }
        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