Exago .NET API Documentation
GetFolder Method
Example 
WebReports.Api.Roles Namespace > FolderCollection Class : GetFolder Method
The name (not path) of the folder to retrieve from the FolderCollection.
Retrieve a Folder object from the FolderCollection that has the name folderName.
Syntax
public Folder GetFolder( 
   System.string folderName
)

Parameters

folderName
The name (not path) of the folder to retrieve from the FolderCollection.

Return Value

A Folder object from the FolderCollection whose name is folderName.
Exceptions
ExceptionDescription
System.NullReferenceExceptionA NullReferenceException is thrown if a folder with the name in the folderName argument does not exist in the FolderCollection
Example
Role myRole = api.Roles.GetRole("ReportUser");
myRole.Security.Folders.IncludeAll = false;
Label1.Text = myRole.Security.Folders.GetFolder("Screenshots").Name;
See Also

Reference

FolderCollection Class
FolderCollection Members

 

 

Version: 2021.2.6 Last published: 5/18/2022

Contact Exago Support