AFNotificationRuleTemplate.CheckOutNotificationRuleTemplates Method

public static AFNamedCollectionList<AFNotificationRuleTemplate> CheckOutNotificationRuleTemplates(
	PISystem system,
	IList<Guid> ids,
	Object queryDate = null
)

Public Shared Function CheckOutNotificationRuleTemplates ( 
	system As PISystem,
	ids As IList(Of Guid),
	Optional queryDate As Object = Nothing
) As AFNamedCollectionList(Of AFNotificationRuleTemplate)

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

returnValue = AFNotificationRuleTemplate.CheckOutNotificationRuleTemplates(system, 
	ids, queryDate)

public:
static AFNamedCollectionList<AFNotificationRuleTemplate^>^ CheckOutNotificationRuleTemplates(
	PISystem^ system, 
	IList<Guid>^ ids, 
	Object^ queryDate = nullptr
)

static member CheckOutNotificationRuleTemplates : 
        system : PISystem * 
        ids : IList<Guid> * 
        ?queryDate : Object 
(* Defaults:
        let _queryDate = defaultArg queryDate null
*)
-> AFNamedCollectionList<AFNotificationRuleTemplate> 

Parameters

system

Type: OSIsoft.AFPISystem
The PISystem containing the objects to be checked out.

ids

Type: System.Collections.GenericIListGuid
A list of the unique identifiers of the objects to be checked out.

queryDate (Optional)

Type: SystemObject
The query date used to find the object. Specify 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

Before an object's configuration can be modified, it must be locked by checking it out for modifications. After making changes, the modifications are saved by calling the ApplyChanges method or the CheckIn method. The UndoCheckOut(Boolean) method can be called to discard any changes.

Most of the properties and methods of an object which modify its configuration attempt to perform an automatic check out. This makes it easier for the user of the SDK because an explicit CheckOut method call does not have to be made before making any changes. But if changes are to be made to many objects, it better to check them out in bulk by using this method with the specified list of ids.

The IsCheckedOutThisSession will be set to when checked out by this method even if it was originally checked out in a different session since the object was not previously loaded to determine if it was previously checked out. The IsCheckedOutThisThread will only be set to if it was not previously checked out in the current application in a different thread.

AFSDK

Reference