EnumerateAuditFolders

Returns the list of audit folders within the current IDEA working folder. Each audit folder within the list is represented by descriptor object of type AuditFolderData (metadata object).

Compatibility

Available as of IDEA version 10.0

Syntax

EnumerateAuditFolders(dataScope as Integer) as Object

Parameter

dataScope

Specifies the level of metadata details delivered by AuditFolderData objects. Possible values are:

Return Value

Collection of AuditFolderData objects. Collections is represented by the class AuditFolderDataAccessor.

This collection class is enumerable, i.e. it can be used in For Each loops within IDEAScript.

Example

Sub Main() 
	Dim mc As Object 
	Dim sc As Object 
	Dim caseAdmin As Object 
	Dim folders As Object 
	Dim data As Object 
	Dim txt As String 
	Dim cnt As Integer 

	Set mc = SmartContext.MacroCommands 
	Set sc = mc.SimpleCommands 
	Set caseAdmin = mc.ProjectAdministration 
	Set folders = caseAdmin.EnumerateAuditFolders(3)  '3 - get all data details 
	Set cnt = folders.Count 

	For i = 0 To cnt - 1 
		Set data = folders.Item(i) 
		Set txt = sc.FormatString("Name:{0}; Audit type:{1}; Audit area:{2}; folder type:{3}", 
		data.Name, data AuditType, data.AuditSubject, data.FolderType) 
		SmartContext.Trace txt 
		Set txt = sc.FormatString (" From {0:dd.MM.yyyy} to {1:dd.MM.yyyy}", 
		data.Periods.From, data.Periods.To) 
		SmartContext.Trace txt 
		Set txt = sc.FormatString ("  Number of related folders: {0}", 
		data.RelatedFoldersList.Count) 
		SmartContext.Trace txt 

	Next 
	Set data = Nothing 
	Set folders = Nothing 
	Set caseAdmin = Nothing 
	Set sc = Nothing 
	Set mc = Nothing 

End Sub

Copy example