Click or drag to resize
IQMSGetDocumentFolder Method
Gets the document folder with the specified ID.

Namespace: PIX.Services.V12
Assembly: 
Syntax
DocumentFolder GetDocumentFolder(
	Guid id,
	DocumentFolderScope scope
)

Parameters

id
Type: SystemGuid
The ID of the document folder to retrieve.
scope
Type: PIX.QMSAPI.DataObjectsDocumentFolderScope
The scope of the document folder to retrieve.

Return Value

Type: DocumentFolder
The document folder with the specified ID and scope.
Exceptions
ExceptionCondition
ExceptionThrown if the caller does not have access to the document folder with the specified ID.
Remarks
Security note Security Note

Requires membership of local group QlikView Management API and the role Document Folder Administrator.

Examples
The following code example retrieves the document folder for a certain task and prints the administrators set on the folder.

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

           //Id of a known task 
           Guid someTaskId = new Guid("5ac16136-f00b-47c4-8099-23ff7f178423");
           DocumentTask documentTask = apiClient.GetDocumentTask(someTaskId, DocumentTaskScope.All);

           if(documentTask != null)
           {
               DocumentFolder folder = apiClient.GetDocumentFolder(documentTask.Document.FolderID, DocumentFolderScope.All);
               if(folder != null)
               {
                   Console.WriteLine("Path:" + folder.General.Path);
                   Console.WriteLine("Administrators:");
                   folder.Administrators.UserNames.ForEach(name=>Console.Write(name + ";"));
               }
           }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
See Also