AFDatabase.AddTransfer Method (String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Creates a new AFTransfer without specifying a template.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFTransfer AddTransfer( string name )
Public Function AddTransfer ( name As String ) As AFTransfer Dim instance As AFDatabase Dim name As String Dim returnValue As AFTransfer returnValue = instance.AddTransfer(name)
public: AFTransfer^ AddTransfer( String^ name )
member AddTransfer : name : string -> AFTransfer
Parameters
- name
- Type: SystemString
The name for the new transfer object. The name is validated to be unique within the collection of transfers currently loaded on the client. This does not guarantee that the name will be unique, but helps to prevent duplicate names from being created. If the name ends with an asterisk (*), then a unique name will be generated based on the supplied name. See the ValidateName(String, String) method for a description of what is valid when setting the name of the object.
Return Value
Type: AFTransferReturns the AFTransfer that was added.
Remarks
This method creates a new AFTransfer without specifying a template.
Since an AFElementTemplate was not specified, properties that are
normally defined by the template are defined by the transfer instead. The
StartTime, EndTime,
Source, and Destination
are initially left undefined; you must update these before checking in.