AF SDK Reference

AFCase.CollectInputs Method (AFCaseLog)

Save PDF

TABLE OF CONTENTS

AFCase.CollectInputs Method (AFCaseLog)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Note: This API is now obsolete.

This method uses the AFAnalysisRule to obtain the input values necessary to start an analysis.

Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

[BrowsableAttribute(false)]
[ObsoleteAttribute("This method has been replaced by 'CollectInputs()'.")]
public bool CollectInputs(
	AFCaseLog caseLog
)

<BrowsableAttribute(false)>
<ObsoleteAttribute("This method has been replaced by 'CollectInputs()'.")>
Public Function CollectInputs ( 
	caseLog As AFCaseLog
) As Boolean

Dim instance As AFCase
Dim caseLog As AFCaseLog
Dim returnValue As Boolean

returnValue = instance.CollectInputs(caseLog)

public:
[BrowsableAttribute(false)]
[ObsoleteAttribute(L"This method has been replaced by 'CollectInputs()'.")]
bool CollectInputs(
	AFCaseLog^ caseLog
)

[<BrowsableAttribute(false)>]
[<ObsoleteAttribute("This method has been replaced by 'CollectInputs()'.")>]
member CollectInputs : 
        caseLog : AFCaseLog -> bool

Parameters

caseLog: Type: OSIsoft.AF.AnalysisAFCaseLog
The log of messages. An initialized log can be obtained from the Log property or a new one can be created.

Return Value

Type: Boolean
Returns if the operation was successful. Upon return, the caseLog will contain any messages generated during the collection process.

Remarks

This method is obsolete and has been replaced by the CollectInputs() method.

Version Information

AFSDK

Obsolete (compiler warning) in 3.1.1
Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5
Obsolete (compiler warning) in 2.10.0
Obsolete (compiler warning) in 2.10
Obsolete (compiler warning) in 2.9.5
Obsolete (compiler warning) in 2.9
Obsolete (compiler warning) in 2.8.5
Obsolete (compiler warning) in 2.8
Obsolete (compiler warning) in 2.7.5
Obsolete (compiler warning) in 2.7
Obsolete (compiler warning) in 2.6
Obsolete (compiler warning) in 2.5
Obsolete (compiler warning) in 2.4

AF SDK Reference