Get4File

Gets extended parameter specified by name and value for IDEA database.

Compatibility

Available as of IDEA version 10.1

Syntax

Get4File(fileName As String, paramName As String, [optional] recursive As Boolean, [optional] location As Integer) As String

Parameters

fileName

IDEA database name

paramName

Extended parameter name

paramValue

[optional] Recursive search flag. If set to True, the parameter search is continued at higher levels (folder, project, workflow, company) in case parameter cannot be found at file level.

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

Parameter's value as string. If parameter cannot be found, an empty string is returned.

Example

Sub Main() 
	Dim mc As Object 
	Dim sc As Object 
	Dim parameterizer As Object 
	Dim date As Date 
	Dim value As String 

	Date = DateSerial(2000, 1, 1) 

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

	'Setting values for a file 
	parameterizer.Set4File SmartContext.PrimaryInputFile "IntVal", 20 
	parameterizer.Set4File SmartContext.PrimaryInputFile "DateTimeVal", date 

	' Setting values for audit folder 
	parameterizer.Set4AuditFolder "2015_0603", "IntVal", 100 
	parameterizer.Set4AuditFolder "2014_0603", "StringVal", "Some String" 

	' Setting values for current project 
	parameterizer.Set4Project "IntVal", 200 
	parameterizer.Set4Project "DateTimeVal", Date 

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

	' Getting integer value for audit folder. Expected value is "100" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "IntVal") 

	' Getting String value for audit folder. Expected value is "Some String" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "StringVal") 

	' Getting Date value for audit folder non-recursively. Expected value is "" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "DateTimeVal") 

	' Getting Date value for audit folder recursively. 
	' Expected value is "2000-01-01T00:00:00" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "DateTimeVal", True) 

	' Getting integer value for project. Expected value is "200" 
	Set value = parameterizer.Get4Project("IntVal") 
	
	' Getting Date value for project. Expected value is "2000-01-01T00:00:00" 
	Set value = parameterizer.Get4Project "DateTimeVal") 

	' Getting float value for project non-recursively. Expected value is "" 
	Set value = parmeterizer.Get4Project("FloatVal") 

	' Getting float value for project recursively. Expected value is "456,78" 
	Set value = parmeterizer.Get4Project("FloatVal", True) 

	' Getting float value for machine/company. Expected value is "456,78" 
	Set value = parameterizer.Get4Machine("FloatVal") 
End Sub

Copy example

Sub Main() 
	Dim mc As Object 
	Dim sc As Object 
	Dim parameterizer As Object 
	Dim date As Date 
	Dim value As String 

	Date = DateSerial(2000, 1, 1) 

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

	'Setting values for a file 
	parameterizer.Set4File SmartContext.PrimaryInputFile "IntVal", 20 
	parameterizer.Set4File SmartContext.PrimaryInputFile "DateTimeVal", date 

	' Setting values for audit folder 
	parameterizer.Set4AuditFolder "2015_0603", "IntVal", 100 
	parameterizer.Set4AuditFolder "2014_0603", "StringVal", "Some String" 

	' Setting values for current project 
	parameterizer.Set4Project "IntVal", 200 
	parameterizer.Set4Project "DateTimeVal", Date 

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

	' Getting integer value for audit folder. Expected value is "100" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "IntVal") 

	' Getting String value for audit folder. Expected value is "Some String" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "StringVal") 

	' Getting Date value for audit folder non-recursively. Expected value is "" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "DateTimeVal") 

	' Getting Date value for audit folder recursively. 
	' Expected value is "2000-01-01T00:00:00" 
	Set value = parameterizer.Get4AuditFolder("2015_0603", "DateTimeVal", True) 

	' Getting integer value for project. Expected value is "200" 
	Set value = parameterizer.Get4Project("IntVal") 
	
	' Getting Date value for project. Expected value is "2000-01-01T00:00:00" 
	Set value = parameterizer.Get4Project "DateTimeVal") 

	' Getting float value for project non-recursively. Expected value is "" 
	Set value = parmeterizer.Get4Project("FloatVal") 

	' Getting float value for project recursively. Expected value is "456,78" 
	Set value = parmeterizer.Get4Project("FloatVal", True) 

	' Getting float value for machine/company. Expected value is "456,78" 
	Set value = parameterizer.Get4Machine("FloatVal") 
End Sub

Copy example