AFTransfer.FindTransfers Method (AFDatabase, Object, Int32, Boolean, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate)
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
Note: This API is now obsolete.
Retrieves a list of AFTransfer objects limited to the specified
count beginning at the requested start time in the specified direction.
Namespace: OSIsoft.AF.EventFrame
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[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, bool forward, 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, forward As Boolean, 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 forward As Boolean 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, forward, 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, bool forward, 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 * forward : bool * 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 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. - forward
- Type: SystemBoolean
Indicates the direction in time from the start time to proceed when returning transfers. If , then transfers greater than or equal to the start time (moving forward in time) are returned. If , then transfers less than or equal to the start time (moving backward in time) are returned. - 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
Type: AFNamedCollectionListAFTransferReturns the list of AFTransfer objects which match the search criteria.
Remarks
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.
Version Information
AFSDK
Obsolete (compiler warning) in 3.1.1Obsolete (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