Delete4AuditFolder

Deletes extended parameters specified by name for the specified audit folder.

Compatibility

Available as of IDEA version 10.0

Syntax

Delete4AuditFolder(folderName As String, paramName As String, [optional] recursive As Boolean, [optional] location As Integer) As Integer

Parameters

folderName

Audit folder name

paramName

Extended parameter name

paramValue

[optional] recursive search flag. If set to true, the parameter is also deleted at all higher levels (folder, workflow, company).

location

[optional] Place where the databases are located(desktop or server).

UseContext = 0 represents the current behavior.

Desktop = 1 stores always on desktop (ignored on server).

Server = 2 stores data always on the server.

Return Value

Number of deleted parameters

Example

Sub Main() 
Dim mc As Object 
Dim sc As Object 
Dim parameterizer As Object 
Dim cnt As Integer 

Set mc = SmartContext.MacroCommands 
Set sc = mc.SimpleCommands 
Set parameterizer = mc.GlobalParameters 

'Setting string value for primary input file 
parameterizer.Set4File SmartContext.PrimaryInputFile, "StringVal", "HaHaHa" 

' Setting values for audit folder 
parameterizer.Set4AuditFolder "2015_0603", "IntVal", 100 

' Setting values for current project 
parameterizer.Set4Project "IntVal", 200 
parameterizer.Set4Project "FloatVal ", 123.45 

' Setting values for machine/company 
parameterizer.Set4Machine "FloatVal", 456.78 

' Deleting integer value for audit folder non-recursively. Expected value is 1 
Set cnt = parameterizer.Delete4AuditFolder("2015_0603", "IntVal") 

' Deleting integer value for audit folder non-recursively again. Expected value is 0 
Set cnt = parameterizer.Delete4AuditFolder("2015_0603", "IntVal") 

' Deleting integer value for audit folder recursively. Expected value is 1 
Set cnt = parameterizer.Delete4AuditFolder("2015_0603", "IntVal", True) 

' Deleting float value for project recursively. Expected value is 2 
Set cnt = parameterizer.Delete4Project("FloatVal", True) 

' Deleting float value for machine/company. Expected value is 0 
Set cnt = parameterizer.Delete4Machine("FloatVal") 

End Sub

Copy example