AFContact.FindContact Method (PISystem, String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Retrieves the AFContact object with the specified name.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static AFContact FindContact( PISystem system, string name )
Public Shared Function FindContact ( system As PISystem, name As String ) As AFContact Dim system As PISystem Dim name As String Dim returnValue As AFContact returnValue = AFContact.FindContact(system, name)
public: static AFContact^ FindContact( PISystem^ system, String^ name )
static member FindContact : system : PISystem * name : string -> AFContact
Parameters
- system
- Type: OSIsoft.AFPISystem
The PISystem to search for the desired object. - name
- Type: SystemString
The Name or the full CanonicalName of the contact to find. When the full CanonicalName is specified, the AFActiveDirectoryProperties.UserFolder setting is ignored.
Return Value
Type: AFContactThe AFContact in the PISystem which matches the name.
Remarks
The AFContact object with the specified name
is returned. If the object does not exist, then will be returned.