AFNotificationRuleSearch.GetObjectFields Method
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
Get the list of valid object fields that can used for the FindObjectFields(String, Int32, Int32)
search for the specified server.
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156
Syntax
public static ICollection<string> GetObjectFields( PISystem system = null )
Public Shared Function GetObjectFields ( Optional system As PISystem = Nothing ) As ICollection(Of String) Dim system As PISystem Dim returnValue As ICollection(Of String) returnValue = AFNotificationRuleSearch.GetObjectFields(system)
public: static ICollection<String^>^ GetObjectFields( PISystem^ system = nullptr )
static member GetObjectFields : ?system : PISystem (* Defaults: let _system = defaultArg system null *) -> ICollection<string>
Parameters
- system (Optional)
- Type: OSIsoft.AF.PISystem
The server used to determine if an object field is valid. If null, then the full list of valid object fields are returned for all servers.
Return Value
Type: ICollection<String>Returns the read-only list of valid object fields that can used for the FindObjectFields(String, Int32, Int32) search for the specified server.
Remarks
This method will return the list of object fields that are valid to be used in the
FindObjectFields(String, Int32, Int32) search for the specified system.