AFTransfer.FindTransfers Method (AFDatabase, Object, Int32, AFEventFrameSearchMode, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate)

[BrowsableAttribute(false)]
[ObsoleteAttribute("This method has been replaced by the 'AFTransferSearch' class using the 'Start', 'Name', 'Source', 'Destination', 'Category', and 'Template' filters.")]
public static AFNamedCollectionList<AFTransfer> FindTransfers(
	AFDatabase database,
	Object startTime,
	int maxCount,
	AFEventFrameSearchMode searchMode,
	string nameFilter,
	AFBaseElement sourceFilter,
	AFBaseElement destinationFilter,
	AFCategory elemCategory,
	AFElementTemplate elemTemplate
)

<BrowsableAttribute(false)>
<ObsoleteAttribute("This method has been replaced by the 'AFTransferSearch' class using the 'Start', 'Name', 'Source', 'Destination', 'Category', and 'Template' filters.")>
Public Shared Function FindTransfers ( 
	database As AFDatabase,
	startTime As Object,
	maxCount As Integer,
	searchMode As AFEventFrameSearchMode,
	nameFilter As String,
	sourceFilter As AFBaseElement,
	destinationFilter As AFBaseElement,
	elemCategory As AFCategory,
	elemTemplate As AFElementTemplate
) As AFNamedCollectionList(Of AFTransfer)

Dim database As AFDatabase
Dim startTime As Object
Dim maxCount As Integer
Dim searchMode As AFEventFrameSearchMode
Dim nameFilter As String
Dim sourceFilter As AFBaseElement
Dim destinationFilter As AFBaseElement
Dim elemCategory As AFCategory
Dim elemTemplate As AFElementTemplate
Dim returnValue As AFNamedCollectionList(Of AFTransfer)

returnValue = AFTransfer.FindTransfers(database, 
	startTime, maxCount, searchMode, 
	nameFilter, sourceFilter, destinationFilter, 
	elemCategory, elemTemplate)

public:
[BrowsableAttribute(false)]
[ObsoleteAttribute(L"This method has been replaced by the 'AFTransferSearch' class using the 'Start', 'Name', 'Source', 'Destination', 'Category', and 'Template' filters.")]
static AFNamedCollectionList<AFTransfer^>^ FindTransfers(
	AFDatabase^ database, 
	Object^ startTime, 
	int maxCount, 
	AFEventFrameSearchMode searchMode, 
	String^ nameFilter, 
	AFBaseElement^ sourceFilter, 
	AFBaseElement^ destinationFilter, 
	AFCategory^ elemCategory, 
	AFElementTemplate^ elemTemplate
)

[<BrowsableAttribute(false)>]
[<ObsoleteAttribute("This method has been replaced by the 'AFTransferSearch' class using the 'Start', 'Name', 'Source', 'Destination', 'Category', and 'Template' filters.")>]
static member FindTransfers : 
        database : AFDatabase * 
        startTime : Object * 
        maxCount : int * 
        searchMode : AFEventFrameSearchMode * 
        nameFilter : string * 
        sourceFilter : AFBaseElement * 
        destinationFilter : AFBaseElement * 
        elemCategory : AFCategory * 
        elemTemplate : AFElementTemplate -> AFNamedCollectionList<AFTransfer> 

Parameters

database

Type: OSIsoft.AFAFDatabase
The AFDatabase to search for the requested objects.

startTime

Type: SystemObject
An object representing the starting time to begin the search. The search may compare against either the StartTime or EndTime of the transfer based on the searchMode parameter. 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 the object's QueryDate.

maxCount

Type: SystemInt32
The maximum number of transfers to be returned. More than the specified number may be returned if multiple items have the same StartTime for the last transfer returned.

searchMode

Type: OSIsoft.AF.EventFrameAFEventFrameSearchMode
Indicates the direction in time from the StartTime or EndTime to proceed when returning transfers.

nameFilter

Type: SystemString
If not an empty string, only transfers which match the supplied filter on their name property will be returned.

sourceFilter

Type: OSIsoft.AF.AssetAFBaseElement
If not , only AFTransfers with the specified Source will be returned.

destinationFilter

Type: OSIsoft.AF.AssetAFBaseElement
If not , only AFTransfers with the specified Destination will be returned.

elemCategory

Type: OSIsoft.AFAFCategory
Specify that returned transfers must have this category. To not filter by element category, then specify for this parameter.

elemTemplate

Type: OSIsoft.AF.AssetAFElementTemplate
Specify that returned transfers must have this template or a template derived from this template. To not filter by element template, then specify for this parameter.

Return Value

A transfer must be saved to the server using ApplyChanges or CheckIn before it will be returned by this find method. This method will return all transfers from the specified start time up to the specified maximum count.

Important
Consider using the new AFTransferSearch class for finding transfers instead of using this method.

AFSDK

Reference