AFCase.LoadCases Method (PISystem, Guid[], Object)

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.AnalysisAFCase ClassAFCase MethodsLoadCases Method AFCase.LoadCases Method (PISystem, Guid[], Object)

TABLE OF CONTENTS

AFCase.LoadCases Method (PISystem, Guid[], Object)

Save PDF

Feedback

Last UpdatedSep 18, 2024

Loads the AFCase objects with the specified unique identifiers. at the specified query date.

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

Syntax

public static AFNamedCollectionList<AFCase> LoadCases(
	PISystem system,
	Guid[] ids,
	Object queryDate
)

Public Shared Function LoadCases ( 
	system As PISystem,
	ids As Guid(),
	queryDate As Object
) As AFNamedCollectionList(Of AFCase)

Dim system As PISystem
Dim ids As Guid()
Dim queryDate As Object
Dim returnValue As AFNamedCollectionList(Of AFCase)

returnValue = AFCase.LoadCases(system, 
	ids, queryDate)

public:
static AFNamedCollectionList<AFCase^>^ LoadCases(
	PISystem^ system, 
	array<Guid>^ ids, 
	Object^ queryDate
)

static member LoadCases : 
        system : PISystem * 
        ids : Guid[] * 
        queryDate : Object -> AFNamedCollectionList<AFCase>

Parameters

system: Type: OSIsoft.AF.PISystem
The PISystem to search for the desired objects.
ids: Type:System.Guid[]
An array of the unique identifiers of the objects to load.
queryDate: Type: System.Object
The query date used to load the objects. Specify null or AFTime.MaxValue for most recent versions of the objects. The value may be an AFTime, DateTime, PITime, String, or numeric. A DateTime (or a DATE will be treated as UTC time if its Kind property is set to Unspecified. Because DATE values from COM or VB6 clients are marshalled as Unspecified, these client applications must convert to UTC prior to marshalling. An integer numeric represents the number of ticks (100-nanosecond intervals) since January 1, 0001. A floating point numeric represents the number of seconds since January 1, 1970 UTC. A String is interpreted as local time, unless it contains a time zone indicator such as a trailing "Z" or "GMT". Strings will be interpreted with the AFTime.Parse Overload methods so that relative formats with intervals ("*", "T+3h", etc.) are also supported. Relative time intervals are based on AFTime.Now.

Return Value

Type: AFNamedCollectionList<AFCase>
Returns a collection of the objects in the system which match the unique identifiers in the ids list at the specified queryDate. If no object can be found for a unique identifier in the list, there will be no corresponding entry in the returned collection. The order of items in the returned collection might not match the order of specified ids, but the returned collection items can be accessed by ID.

Remarks

Fully loads the AFCase objects from the server into the client with the specified ids at the specified queryDate. If the object is already loaded in memory, then it will be updated if it has been marked as needing to reload by a call to AFDatabase.Refresh. If you do not need the objects fully loaded, you can use the FindCases(PISystem,Guid[], Object) method which will only load the headers for each object.

AF SDK Reference

Filters

Product Family