AFTransfer.FindTransfers Method (AFDatabase, AFSearchMode, Object, Object, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate, AFSortField, AFSortOrder, Int32)

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

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

Dim database As AFDatabase
Dim searchMode As AFSearchMode
Dim startTime As Object
Dim endTime As Object
Dim nameFilter As String
Dim sourceFilter As AFBaseElement
Dim destinationFilter As AFBaseElement
Dim elemCategory As AFCategory
Dim elemTemplate As AFElementTemplate
Dim sortField As AFSortField
Dim sortOrder As AFSortOrder
Dim maxCount As Integer
Dim returnValue As AFNamedCollectionList(Of AFTransfer)

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

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

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

Parameters

database

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

searchMode

Type: OSIsoft.AF.AssetAFSearchMode
Determines how the startTime and endTime parameters are treated when searching for transfer objects to be included in the returned collection.

startTime

Type: SystemObject
An object representing the starting time for the search. The startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the transfer's StartTime or EndTime. 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.

endTime

Type: SystemObject
An object representing the ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's StartTime or EndTime. 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.

nameFilter

Type: SystemString
The transfer name filter string used for finding objects.

The query string (or match pattern) can include regular characters and wildcard characters. Regular characters must match exactly the characters specified in the query string. Wildcard characters can be matched with arbitrary fragments of the query string. Wildcard characters can be escaped using the single backslash (\) character. Use a double backslash (\\) to match a single backslash. The syntax of the query string has the following rules:

• If or empty string, then everything will be matched.
• If no wildcards, then an exact match on the query string is performed.
• Wildcard * can be placed anywhere in the query string and matches zero or more characters.
• Wildcard ? can be placed anywhere in the query string and matches exactly one character.
• One character in a set of characters are matched by placing them within [ ]. For example, a[bc] would match 'ab' or 'ac', but it would not match 'ad' or 'abd'.
• One character in a set of characters are not matched by placing them within [! ]. For example, a[!bc] would match 'ad', but it would not match 'ab', 'ac', or 'abd'.
• A character in a range of characters from first to last are matched using the following syntax: [first - last]. For example, a[a-c] would match 'aa', 'ab', or 'ac', but it would not match 'ad' or 'abc'.

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.

sortField

Type: OSIsoft.AFAFSortField
The field or property of the object used to sort the returned collection.

sortOrder

Type: OSIsoft.AFAFSortOrder
The order that the returned collection is sorted.

maxCount

Type: SystemInt32
The maximum number of objects to be returned.

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 a list of transfers within a time range.

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

AFSDK

Reference