OPC Systems.NET Programmatic Interface Component
The OPC Systems.NET Programmatic Interface Component allows developers to build applications easily that can communicate and configure both local and remote OPC Systems Services. The component is free to use with any licensed OPC Systems Service.
Smart Client Deployment
- All OPC Systems.NET components are Smart Client compatible.
-
Application execution on remote systems without installing the application on the remote systems.
-
Better user experience than web browser applications.
-
Application updates to one directory and all remote systems are updated automatically.
-
Tighter security control than web browser applications using built in .NET Framework security.
-
Refer to OPC Systems.NET help file for Smart Client Deployment steps.
Examples of each of the methods and properties listed below can viewed in the Example application that installs with OPC Systems.NET.
General
The GetFullyLicensed Function returns the license status of an OPC Systems Service. Returns -1 if service is not reachable. Returns 0 if the service is not yet fully licensed, running in demo mode or disabled. Returns 1 if the service has been licensed. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetFullyLicensed( _
ByVal NetworkNode As String _
) As Integer
[C#]
public int GetFullyLicensed(
string NetworkNode
);
The GetLicenseString Function returns a string of the OPC Systems Service license. Returns OPC Systems Service Not Reachable if service is not reachable. Returns the license string if successful. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetLicenseString( _
ByVal NetworkNode As String _
) As String
[C#]
public string GetLicenseString(
string NetworkNode
);
The GetListOfOPCServers Function returns a list of Registered OPC Servers from the Network Node as a String Array. Returns empty String Array if no Registered Servers are found or if the OPC Systems Service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetListOfOPCServers( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetListOfOPCServers(
string NetworkNode
);
The GetOPCBranches Function returns a list of Branches from the OPC Servers as a String Array. Returns empty String Array if no Branches are found or if the OPC Systems Service is not reachable. OPCServer is the name of the OPC Server to browse. ReferencePath is a string of the branches path to browse. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetOPCBranches( _
ByVal OPCServer As String, _
ByVal ReferencePath As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetOPCBranches(
string OPCServer,
string ReferencePath,
string NetworkNode
);
The GetOPCItems Function returns a list of Items from the OPC Servers as a String Array. Returns empty String Array if no Items are found or the OPC Systems Service is not reachable. OPCServer is the name of the OPC Server to browse. ReferencePath is a string of the branches path to browse. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetOPCItems( _
ByVal OPCServer As String, _
ByVal ReferencePath As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetOPCItems(
string OPCServer,
string ReferencePath,
string NetworkNode
);
The GetNetworkNodes Function returns a list of Network Nodes from the local system as a String Array. Returns empty String Array if no Network Nodes are found.
[Visual Basic]
Public Function GetNetworkNodes() As String()
[C#]
public string[] GetNetworkNodes()
The GetVersion Function is useful for an easy check if the OPC Systems Service is started and reachable. Returns -1 if service is not reachable. Returns positive number of current version if successful. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetVersion( _
ByVal NetworkNode As String _
) As Integer
[C#]
public int GetVersion(
string NetworkNode
);
The InRuntime Function returns the Runtime Status of an OPC Systems Service. Returns -1 if service is not reachable. Returns 0 if service is not in Runtime. Returns 1 if service is in Runtime. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function InRuntime( _
ByVal NetworkNode As String _
) As Integer
[C#]
public int InRuntime(
string NetworkNode
);
The StartRuntime Subroutine Starts the OPC Systems Service Runtime Mode. If the Service is already in Runtime Mode no method occurs. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub StartRuntime( _
ByVal NetworkNode As String _
)
[C#]
public void StartRuntime(
string NetworkNode
);
The StopRuntime Subroutine Stops the OPC Systems Service Runtime Mode. If the Service is not in Runtime Mode no method occurs. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub StopRuntime( _
ByVal NetworkNode As String _
)
[C#]
public void StopRuntime(
string NetworkNode
);
Groups
The AddGroup Function adds a Group to the existing Tag configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group already exists or adding the Group failed. Group is the name of the Group to add. ReferenceGroup is a string of the Group path to add the Group to. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AddGroup( _
ByVal Group As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int AddGroup(
string Group,
string ReferenceGroup,
string NetworkNode
);
The GetGroupNames Function returns a list of Groups in the specified ReferenceGroup path. Returns Empty String Array if service is not reachable. Returns a String Array of Groups in the ReferenceGroup. ReferenceGroup is a string of the Group path to retrieve the Groups from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetGroupNames( _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetGroupNames(
string ReferenceGroup,
string NetworkNode
);
The RemoveGroup Function removes a Group from the existing Tag configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group does not exist or removing the Group failed. Group is the name of the Group to remove. ReferenceGroup is a string of the Group path to remove the Group from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function RemoveGroup( _
ByVal Group As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int RemoveGroup(
string Group,
string ReferenceGroup,
string NetworkNode
);
The RenameGroup Function renames an existing Group in the Tag configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Old Group does not exist, the New Group already exists, or renaming the Group failed. OldGroup is the name of the existing Group to rename. NewGroup is the name to change the Group to. ReferenceGroup is a string of the Group path to rename the Group in. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function RenameGroup( _
ByVal OldGroupName As String, _
ByVal NewGroupName As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int RenameGroup(
string OldGroupName,
string NewGroupName,
string ReferenceGroup,
string NetworkNode
);
Tags
The AddTag Function adds a Tag to the existing Tag configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Tag already exists or adding the Tag failed. Tag is the name of the Tag to add. ReferenceGroup is a string of the Group path to add the Tag to. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AddTag( _
ByVal Tag As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int AddTag(
string Tag,
string ReferenceGroup,
string NetworkNode
);
The DeleteAllTags Function removes all Tags from the existing Tag configuration. Returns -1 if service is not reachable. Returns 1 if successful. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function DeleteAllTags( _
ByVal NetworkNode As String _
) As Integer
[C#]
public int DeleteAllTags(
string NetworkNode
);
The GetParameter_Property_Strings Function returns an array of Strings containing all property types available for each Parameter. Returns Empty String Array if service is not reachable. Returns a String Array of property types for all Parameters. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetParameter_Property_Strings( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetParameter_Property_Strings(
string NetworkNode
);
The GetTag_Parameter_Strings Function returns an array of Strings containing all Parameter Types available for each Tag. Returns Empty String Array if service is not reachable. Returns a String Array of Parameter Types for all Tags. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetTag_Parameter_Strings( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetTag_Parameter_Strings(
string NetworkNode
);
The GetTag_Parameter_Value Function returns an object value for the Tag.Parameter.Property specified. Returns nothing if service is not reachable. Parameter is a String of the Parameter Type desired of the Tag. PropertyType is a String of the Property Type desired of the Parameter. TagName is a String of the Tag desired. ReferenceGroup is a String of the Group(s) where the Tag is to be contained. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetTag_Parameter_Value( _
ByVal Parameter As String, _
ByVal PropertyType As String, _
ByVal TagName As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Object
[C#]
public object GetTag_Parameter_Value(
string Parameter,
string PropertyType,
string TagName,
string ReferenceGroup,
string NetworkNode
);
The GetTag_Parameter_Values Function returns an array of object values for the Tag.Parameter specified. The order of the array corresponds with the GetParameter_Property_Strings Function order. Returns empty array if service is not reachable. Parameter is a String of the Parameter Type desired of the Tag. TagName is a String of the Tag desired. ReferenceGroup is a String of the Group(s) where the Tag is to be contained. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetTag_Parameter_Values( _
ByVal Parameter As String, _
ByVal TagName As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Object()
[C#]
public object[] GetTag_Parameter_Values(
string Parameter,
string TagName,
string ReferenceGroup,
string NetworkNode
);
The GetTagNames Function returns a list of Tags in the specified ReferenceGroup path. Returns Empty String Array if service is not reachable. Returns a String Array of Tags in the ReferenceGroup. ReferenceGroup is a string of the Group path to retrieve the Tags from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetTagNames( _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetTagNames(
string ReferenceGroup,
string NetworkNode
);
The LoadTagConfiguration Subroutine saves the current Tag configuration to the specified file path. ConfigurationFilePath is the file path to load in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub LoadTagConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void LoadTagConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The RemoveTag Function removes a Tag from the existing Tag configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Tag does not exist. Tag is the name of the Tag to remove. ReferenceGroup is a string of the Group path to remove the Tag from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function RemoveTag( _
ByVal Tag As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int RemoveTag(
string Tag,
string ReferenceGroup,
string NetworkNode
);
The SaveTagConfiguration Subroutine saves the current Tag configuration to the specified file path. ConfigurationFilePath is the file path to save in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub SaveTagConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void SaveTagConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The SetTag_Parameter_Value Function sets an object value for the Tag.Parameter.Property specified. Returns -1 if service is not reachable. Returns 1 if the function was successful. Parameter is a String of the Parameter Type desired of the Tag. PropertyType is a String of the Property Type desired of the Parameter. Value is the desired value to set. TagName is a String of the Tag desired. ReferenceGroup is a String of the Group(s) where the Tag is to be contained. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Overloads Public Function SetTag_Parameter_Value( _
ByVal Parameter As String, _
ByVal PropertyType As String, _
ByVal Value As Object, _
ByVal TagName As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetTag_Parameter_Value(
string Parameter,
string PropertyType,
object Value,
string TagName,
string ReferenceGroup,
string NetworkNode
);
The SetTag_Parameter_Values Function sets an object value for the Tag.Parameter.Property specified. Returns -1 if service is not reachable. Returns 1 if the function was successful. Parameters is a String array of the Parameter Types desired of the Tag. PropertyTypes is a String array of the Property Type desired of the Parameter. Values is an Object array the desired values to set. TagName is a String of the Tag desired. ReferenceGroup is a String of the Group(s) where the Tag is to be contained. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Overloads Public Function SetTag_Parameter_Value( _
ByVal Parameters As String(), _
ByVal PropertyTypes As String(), _
ByVal Values As Object(), _
ByVal TagName As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetTag_Parameter_Value(
string[] Parameters,
string[] PropertyTypes,
object[] Values,
string TagName,
string ReferenceGroup,
string NetworkNode
);
Trend Points
The GetHistoryTagNames Function returns a list of Field Names in the Data Logging Group. Returns Empty String if service is not reachable. Returns a String Array of Field Names in the Data Logging Group. Group is a string of the Data Logging Group path to retrieve the Field Names from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetHistoryTagNames( _
ByVal Group As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetHistoryTagNames(
string Group,
string NetworkNode
);
The GetTrendPointGroupNames Function returns a list of Groups in the specified ReferenceGroup path that contain Tags that are enabled for trending. Returns Empty String if service is not reachable. Returns a String Array of Groups in the ReferenceGroup that have Tags that are enabled for trending. ReferenceGroup is a string of the Group path to retrieve the Groupss from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetTrendPointGroupNames( _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetTrendPointGroupNames(
string ReferenceGroup,
string NetworkNode
);
The GetTrendPointParameterNames Function returns a list of Parameters of a Tag in the specified ReferenceGroup path that is enabled for trending. Returns Empty String if service is not reachable. Returns a String Array of Tags in the ReferenceGroup that are enabled for trending. TagName is a string of the tag name to query. ReferenceGroup is a string of the Group path to retrieve the Tags from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetTrendPointParameterNames( _
ByVal TagName As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetTrendPointParameterNames(
string TagName,
string ReferenceGroup,
string NetworkNode
);
The GetTrendPointTagNames Function returns a list of Tags in the specified ReferenceGroup path that are enabled for trending. Returns Empty String if service is not reachable. Returns a String Array of Tags in the ReferenceGroup that are enabled for trending. ReferenceGroup is a string of the Group path to retrieve the Tags from. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetTrendPointTagNames( _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetTrendPointTagNames(
string ReferenceGroup,
string NetworkNode
);
Data Logging
The AddDataLoggingGroup Function adds a Data Logging Group to the existing Data Logging configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group already exists or adding the Group failed. Group is the name of the Group to add. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AddDataLoggingGroup( _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int AddDataLoggingGroup(
string Group,
string NetworkNode
);
The GetDataLogging_Parameter_Value Function returns an object value for the Data Logging Group and Parameter specified. Returns nothing if service is not reachable. Parameter is a String of the Parameter Type desired of the Data Logging Group. Group is a String of the Data Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetDataLogging_Parameter_Value( _
ByVal Parameter As String, _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Object
[C#]
public object GetDataLogging_Parameter_Value(
string Parameter,
string Group,
string NetworkNode
);
The GetDataLogging_Parameter_Values Function returns an array of object values for the Data Logging Group specified. The order of the array corresponds with the GetDataLoggingParameterStrings Function order. Returns empty array if service is not reachable. Group is a String of the Data Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetDataLogging_Parameter_Values( _
ByVal Group As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Object()
[C#]
public object[] GetDataLogging_Parameter_Values(
string Group,
string ReferenceGroup,
string NetworkNode
);
The GetDataLoggingNames Function returns a list of the Data Logging Groups. Returns Empty String Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetDataLoggingNames( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetDataLoggingNames(
string NetworkNode
);
The GetDataLoggingParameterStrings Function returns an array of Strings containing all property types available for each Data Logging Group. Returns Empty String Array if service is not reachable. Returns a String Array of property types for all possible Parameters for a Data Logging Group. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetDataLoggingParameterStrings( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetDataLoggingParameterStrings(
string NetworkNode
);
The LoadDataLoggingConfiguration Subroutine saves the current Data Logging configuration to the specified file path. ConfigurationFilePath is the file path to load in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub LoadDataLoggingConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void LoadDataLoggingConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The RemoveDataLoggingGroup Function removes a Data Logging Group from the existing Data Logging configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group does not exist or removing the Group failed. Group is the name of the Group to remove. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function RemoveDataLoggingGroup( _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int RemoveDataLoggingGroup(
string Group,
string NetworkNode
);
The SaveDataLoggingConfiguration Subroutine saves the current Data Logging configuration to the specified file path. ConfigurationFilePath is the file path to save in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub SaveDataLoggingConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void SaveDataLoggingConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The SetDataLogging_Parameter_Value Function sets an object value for the Data Logging Group and Parameter specified. Returns -1 if service is not reachable. Returns 0 if the Group does not exist or the value did not get set correctly. Returns 1 if the function was successful. Parameter is a String of the Parameter Type desired of the Data Logging Group. Value is the desired value to set. Group is a String of the Data Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function SetDataLogging_Parameter_Value( _
ByVal Parameter As String, _
ByVal Value As Object, _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetDataLogging_Parameter_Value(
string Parameter,
object Value,
string Group,
string NetworkNode
);
The SetDataLogging_Parameter_Values Function sets multiple Parameter values for the Data Logging Group specified. Returns -1 if service is not reachable. Returns 1 if the function was successful. Parameters is a String array of the Parameter Types desired of the Data Logging Group. Values is an Object array the desired values to set. Group is a String of the Data Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function SetDataLogging_Parameter_Values( _
ByVal Parameters As String(), _
ByVal Values As Object(), _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetDataLogging_Parameter_Values(
string[] Parameters,
object[] Values,
string Group,
string NetworkNode
);
Alarm Logging
The AddAlarmLoggingGroup Function adds an Alarm Logging Group to the existing Alarm Logging configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group already exists or adding the Group failed. Group is the name of the Group to add. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AddAlarmLoggingGroup( _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int AddAlarmLoggingGroup(
string Group,
string NetworkNode
);
The GetAlarmLogging_Parameter_Value Function returns an object value for the Alarm Logging Group and Parameter specified. Returns nothing if service is not reachable. Parameter is a String of the Parameter Type desired of the Alarm Logging Group. Group is a String of the Alarm Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetAlarmLogging_Parameter_Value( _
ByVal Parameter As String, _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Object
[C#]
public object GetAlarmLogging_Parameter_Value(
string Parameter,
string Group,
string NetworkNode
);
The GetAlarmLogging_Parameter_Values Function returns an array of object values for the Alarm Logging Group specified. The order of the array corresponds with the GetAlarmLoggingParameterStrings Function order. Returns empty array if service is not reachable. Group is a String of the Alarm Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetAlarmLogging_Parameter_Values( _
ByVal Group As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Object()
[C#]
public object[] GetAlarmLogging_Parameter_Values(
string Group,
string ReferenceGroup,
string NetworkNode
);
The GetAlarmLoggingNames Function returns a list of the Alarm Logging Groups. Returns Empty String Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetAlarmLoggingNames( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetAlarmLoggingNames(
string NetworkNode
);
The GetAlarmLoggingParameterStrings Function returns an array of Strings containing all property types available for each Alarm Logging Group. Returns Empty String Array if service is not reachable. Returns a String Array of property types for all possible Parameters for a Data Logging Group. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetAlarmLoggingParameterStrings( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetAlarmLoggingParameterStrings(
string NetworkNode
);
The GetAllAlarmGroups Function returns a list of Alarm Groups in the current Tag Configuration. Returns Empty String Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetAllAlarmGroups( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetAllAlarmGroups(
string NetworkNode
);
The LoadAlarmLoggingConfiguration Subroutine saves the current Alarm Logging configuration to the specified file path. ConfigurationFilePath is the file path to load in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub LoadAlarmLoggingConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void LoadAlarmLoggingConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The RemoveAlarmLoggingGroup Function removes an Alarm Logging Group from the existing Alarm Logging configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group does not exist or removing the Group failed. Group is the name of the Group to remove. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function RemoveAlarmLoggingGroup( _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int RemoveAlarmLoggingGroup(
string Group,
string NetworkNode
);
The SaveAlarmLoggingConfiguration Subroutine saves the current Alarm Logging configuration to the specified file path. ConfigurationFilePath is the file path to save in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub SaveAlarmLoggingConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void SaveAlarmLoggingConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The SetAlarmLogging_Parameter_Value Function sets an object value for the Alarm Logging Group and Parameter specified. Returns -1 if service is not reachable. Returns 0 if the Group does not exist or the value did not get set correctly. Returns 1 if the function was successful. Parameter is a String of the Parameter Type desired of the Alarm Logging Group. Value is the desired value to set. Group is a String of the Data Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function SetAlarmLogging_Parameter_Value( _
ByVal Parameter As String, _
ByVal Value As Object, _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetAlarmLogging_Parameter_Value(
string Parameter,
object Value,
string Group,
string NetworkNode
);
The SetAlarmLogging_Parameter_Values Function sets multiple Parameter values for the Alarm Logging Group specified. Returns -1 if service is not reachable. Returns 1 if the function was successful. Parameters is a String array of the Parameter Types desired of the Alarm Logging Group. Values is an Object array the desired values to set. Group is a String of the Data Logging Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function SetAlarmLogging_Parameter_Values( _
ByVal Parameters As String(), _
ByVal Values As Object(), _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetAlarmLogging_Parameter_Values(
string[] Parameters,
object[] Values,
string Group,
string NetworkNode
);
Reports
The AddReportGroup Function adds a Report Group to the existing Report configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group already exists or adding the Group failed. Group is the name of the Group to add. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AddReportGroup( _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int AddReportGroup(
string Group,
string NetworkNode
);
The GetReport_Parameter_Value Function returns an object value for the Report Group and Parameter specified. Returns nothing if service is not reachable. Parameter is a String of the Parameter Type desired of the Report Group. Group is a String of the Report Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetReport_Parameter_Value( _
ByVal Parameter As String, _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Object
[C#]
public object GetReport_Parameter_Value(
string Parameter,
string Group,
string NetworkNode
);
The GetReport_Parameter_Values Function returns an array of object values for the Report Group specified. The order of the array corresponds with the GetReportParameterStrings Function order. Returns empty array if service is not reachable. Group is a String of the Report Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetReport_Parameter_Values( _
ByVal Group As String, _
ByVal ReferenceGroup As String, _
ByVal NetworkNode As String _
) As Object()
[C#]
public object[] GetReport_Parameter_Values(
string Group,
string ReferenceGroup,
string NetworkNode
);
The GetReportNames Function returns a list of the Report Groups. Returns Empty String Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetReportNames( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetReportNames(
string NetworkNode
);
The GetReportParameterStrings Function returns an array of Strings containing all property types available for each Report Group. Returns Empty String Array if service is not reachable. Returns a String Array of property types for all possible Parameters for a Report Group. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function GetReportParameterStrings( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] GetReportParameterStrings(
string NetworkNode
);
The LoadReportConfiguration Subroutine saves the current Report configuration to the specified file path. ConfigurationFilePath is the file path to load in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub LoadReportConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void LoadReportConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The RemoveReportGroup Function removes a Report Group from the existing Report configuration. Returns -1 if service is not reachable. Returns 1 if successful. Returns 0 if the Group does not exist or removing the Group failed. Group is the name of the Group to remove. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function RemoveReportGroup( _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int RemoveReportGroup(
string Group,
string NetworkNode
);
The SaveReportConfiguration Subroutine saves the current Report configuration to the specified file path. ConfigurationFilePath is the file path to save in reference to the OPC Systems Service. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub SaveReportConfiguration( _
ByVal ConfigurationFilePath As String, _
ByVal NetworkNode As String _
)
[C#]
public void SaveReportConfiguration(
string ConfigurationFilePath,
string NetworkNode
);
The SetReport_Parameter_Value Function sets an object value for the Report Group and Parameter specified. Returns -1 if service is not reachable. Returns 0 if the Group does not exist or the value did not get set correctly. Returns 1 if the function was successful. Parameter is a String of the Parameter Type desired of the Report Group. Value is the desired value to set. Group is a String of the Report Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function SetReport_Parameter_Value( _
ByVal Parameter As String, _
ByVal Value As Object, _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetReport_Parameter_Value(
string Parameter,
object Value,
string Group,
string NetworkNode
);
The SetReport_Parameter_Values Function sets multiple Parameter values for the Report Group specified. Returns -1 if service is not reachable. Returns 1 if the function was successful. Parameters is a String array of the Parameter Types desired of the Report Group. Values is an Object array the desired values to set. Group is a String of the Report Group desired. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function SetReport_Parameter_Values( _
ByVal Parameters As String(), _
ByVal Values As Object(), _
ByVal Group As String, _
ByVal NetworkNode As String _
) As Integer
[C#]
public int SetReport_Parameter_Values(
string[] Parameters,
object[] Values,
string Group,
string NetworkNode
);
CSV Import / Export
The AlarmLoggingCSVExport Function returns an array of comma seperated Strings, each String representing all attributes of a Alarm Logging Group. This function is to be used in conjuction with the AlarmLoggingCSVHeaderString Function. Returns Empty Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AlarmLoggingCSVExport( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] AlarmLoggingCSVExport(
string NetworkNode
);
The AlarmLoggingCSVHeaderString Function returns a String of comma seperated heading to be used with the AlarmLoggingCSVExport Function. Returns Empty String if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AlarmLoggingCSVHeaderString( _
ByVal NetworkNode As String _
) As String
[C#]
public string AlarmLoggingCSVHeaderString(
string NetworkNode
);
The AlarmLoggingCSVImport Function is used to import comma seperated strings to the Alarm Logging configuration. Returns a status String describing the success or failure of the import. Returns Empty String if service is not reachable. CSVStrings is an array of comma seperated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DataLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function AlarmLoggingCSVImport( _
ByVal CSVStrings As String(), _
ByVal NetworkNode As String _
) As String
[C#]
public string AlarmLoggingCSVImport(
string[] CSVStrings,
string NetworkNode
);
The DataLoggingCSVExport Function returns an array of comma seperated Strings, each String representing all attributes of a Data Logging Group. This function is to be used in conjuction with the DataLoggingCSVHeaderString Function. Returns Empty Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function DataLoggingCSVExport( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] DataLoggingCSVExport(
string NetworkNode
);
The DataLoggingCSVHeaderString Function returns a String of comma seperated heading to be used with the DataLoggingCSVExport Function. Returns Empty String if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function DataLoggingCSVHeaderString( _
ByVal NetworkNode As String _
) As String
[C#]
public string DataLoggingCSVHeaderString(
string NetworkNode
);
The DataLoggingCSVImport Function is used to import comma seperated strings to the Data Logging configuration. Returns a status String describing the success or failure of the import. Returns Empty String if service is not reachable. CSVStrings is an array of comma seperated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the DataLoggingCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function DataLoggingCSVImport( _
ByVal CSVStrings As String(), _
ByVal NetworkNode As String _
) As String
[C#]
public string DataLoggingCSVImport(
string[] CSVStrings,
string NetworkNode
);
The ReportCSVExport Function returns an array of comma seperated Strings, each String representing all attributes of a Report Group. This function is to be used in conjuction with the ReportCSVHeaderString Function. Returns Empty Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function ReportCSVExport( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] ReportCSVExport(
string NetworkNode
);
The ReportCSVHeaderString Function returns a String of comma seperated heading to be used with the ReportCSVExport Function. Returns Empty String if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function ReportCSVHeaderString( _
ByVal NetworkNode As String _
) As String
[C#]
public string ReportCSVHeaderString(
string NetworkNode
);
The ReportCSVImport Function is used to import comma seperated strings to the Report configuration. Returns a status String describing the success or failure of the import. Returns Empty String if service is not reachable. CSVStrings is an array of comma seperated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the ReportCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Logging Group Name column must be specified. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function ReportCSVImport( _
ByVal CSVStrings As String(), _
ByVal NetworkNode As String _
) As String
[C#]
public string ReportCSVImport(
string[] CSVStrings,
string NetworkNode
);
The TagCSVExport Function returns an array of comma seperated Strings, each String representing all attributes of a Tag. This function is to be used in conjuction with the TagCSVHeaderString Function. Returns Empty Array if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function TagCSVExport( _
ByVal NetworkNode As String _
) As String()
[C#]
public string[] TagCSVExport(
string NetworkNode
);
The TagCSVHeaderString Function returns a String of comma seperated heading to be used with the TagCSVExport Function. Returns Empty String if service is not reachable. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function TagCSVHeaderString( _
ByVal NetworkNode As String _
) As String
[C#]
public string TagCSVHeaderString(
string NetworkNode
);
The TagCSVImport Function is used to import comma seperated strings to the Tag configuration. Returns a status String describing the success or failure of the import. Returns Empty String if service is not reachable. CSVStrings is an array of comma seperated Strings. The first String in the passed array must be a header String with the unique heading columns that can be obtained with the TagCSVHeaderString Function. Import all or just a few selected columns, but as a minimum the Tag column must be specified. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Function TagCSVImport( _
ByVal CSVStrings As String(), _
ByVal NetworkNode As String _
) As String
[C#]
public string TagCSVImport(
string[] CSVStrings,
string NetworkNode
);
Options
The LoadOptions Subroutine loads the current Option configuration from the default Options file. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub LoadOptions( _
ByVal NetworkNode As String _
)
[C#]
public void LoadOptions(
string NetworkNode
);
The SaveOptions Subroutine saves the current Option configuration. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Sub SaveOptions( _
ByVal NetworkNode As String _
)
[C#]
public void SaveOptions(
string NetworkNode
);
AutoRuntime Property is to enable or disable automatic Start of Runtime Mode when the Service first Starts. Returns a Boolean, True for enabled, False for disabled. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property AutoRuntime As Boolean
[C#]
public bool AutoRuntime {get;set;}
DefaultAlarmLoggingConfigurationFile Property is the default Tag Configuration file to load when LoadDefaultAlarmLoggingConfiguration is enabled. Returns a String of the default Data Logging configuration file to load when the Service first starts. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property DefaultAlarmLoggingConfigurationFile As String
[C#]
public string DefaultAlarmLoggingConfigurationFile {get;set;}
DefaultDataLoggingConfigurationFile Property is the default Tag Configuration file to load when LoadDefaultDataLoggingConfiguration is enabled. Returns a String of the default Data Logging configuration file to load when the Service first starts. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property DefaultDataLoggingConfigurationFile As String
[C#]
public string DefaultDataLoggingConfigurationFile {get;set;}
DefaultReportConfigurationFile Property is the default Tag Configuration file to load when LoadDefaultReportConfiguration is enabled. Returns a String of the default Data Logging configuration file to load when the Service first starts. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property DefaultReportConfigurationFile As String
[C#]
public string DefaultReportConfigurationFile {get;set;}
DefaultTagConfigurationFile Property is the default Tag Configuration file to load when LoadDefaultTagConfiguration is enabled. Returns a String of the default Tag configuration file to load when the Service first starts. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property DefaultTagConfigurationFile As String
[C#]
public string DefaultTagConfigurationFile {get;set;}
LoadDefaultAlarmLoggingConfiguration Property is to enable or disable automatic loading of the DefaultAlarmLoggingConfigurationFile. Returns a Boolean, True for enabled, False for disabled. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property LoadDefaultAlarmLoggingConfiguration As Boolean
[C#]
public bool LoadDefaultAlarmLoggingConfiguration {get;set;}
LoadDefaultDataLoggingConfiguration Property is to enable or disable automatic loading of the DefaultDataLoggingConfigurationFile. Returns a Boolean, True for enabled, False for disabled. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property LoadDefaultDataLoggingConfiguration As Boolean
[C#]
public bool LoadDefaultDataLoggingConfiguration {get;set;}
LoadDefaultReportConfiguration Property is to enable or disable automatic loading of the DefaultReportConfigurationFile. Returns a Boolean, True for enabled, False for disabled. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property LoadDefaultReportConfiguration As Boolean
[C#]
public bool LoadDefaultReportConfiguration {get;set;}
LoadDefaultTagConfiguration Property is to enable or disable automatic loading of the DefaultTagConfigurationFile. Returns a Boolean, True for enabled, False for disabled. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property LoadDefaultTagConfiguration As Boolean
[C#]
public bool LoadDefaultTagConfiguration {get;set;}
OPCServerWatchDogRate Property is the amount of time in seconds that wait for new data from each OPC Server Group before disconnecting and reconnecting the OPC Server Group. Set to 0 to disable the OPC Server Watchdog. Returns an Int32. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property OPCServerWatchDogRate As Integer
[C#]
public int OPCServerWatchDogRate {get;set;}
StartRuntimeDelay Property is the amount of time in seconds that will delay the starting Runtime Mode when the Service first Starts if the AutoRuntime property is enabled. Returns an Int32. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property StartRuntimeDelay As Integer
[C#]
public int StartRuntimeDelay {get;set;}
TimeStampFromOPC Property is set to True to enable setting the TimeStamp of when all Tag Parameters with OPC as the data source to the TimeStamp from the OPC Server. When set to False the TimeStamp comes for the CPU clock of the OPC Systems Service containing the Tag. Returns a Boolean, True for enabled, False for disabled. NetworkNode is the name of the network node of the OPC Systems Service to connect to. Leave blank for localhost connection.
[Visual Basic]
Public Property TimeStampFromOPC As Boolean
[C#]
public bool TimeStampFromOPC {get;set;}
