CmpOPCUAClient Library Documentation ¶ Company System Title CmpOPCUAClient Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ Access the OPC UA client runtime interface Indices and tables ¶ 1 Based on CmpOPCUAClient.library, last modified 20.04.2021, 15:44:05. LibDoc 4.4.0.0-b.27 The content file CmpOPCUAClient.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:44:05.

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:44:05 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpOPCUAClient.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpOPCUAClient.clean.json version version 2.0.0.0 ProjectInformation IsContainerLibrary bool True IsEndUserLibrary False Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 15:44:05 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpOPCUAClient Title CmpOPCUAClient Version version 3.5.17.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpOPCUAClient Implementation ¶ Library Identification ¶ Placeholder: CmpOPCUAClient Implementation Default Resolution: CmpOPCUAClient Implementation, * (System) Namespace: CmpOPCUAClient_Implementation Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpOPCUAClient Implementation CmpOPCUAClient Interfaces ¶ Library Identification ¶ Name: CmpOPCUAClient Interfaces Version: newest Company: System Namespace: CmpOPCUAClient_Interfaces Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpOPCUAClient Interfaces, * (System)

CmpOPCUAClient Interfaces Library Documentation ¶ Company System Title CmpOPCUAClient Interfaces Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ Interfaces of the OPC UA client runtime component Contents: ¶ CmpOPCUAClient Interfaces Interfaces Structs Types Indices and tables ¶ 1 Based on CmpOPCUAClient_Itfs.library, last modified 20.04.2021, 15:44:51. LibDoc 4.4.0.0-b.27 The content file CmpOPCUAClient_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:44:51.

CmpOPCUAClient Interfaces ¶ Interfaces IOPCUAClientConnectionCallback (Interface) ConnectionStateCallback (Method) GetUserCredentials (Method) VerifyServerCertificate (Method) IOPCUAClientDataAccessCallback (Interface) ReadCallback (Method) WriteCallback (Method) IOPCUAClientDiscoveryCallback (Interface) FindServersCallback (Method) FindServersOnNetworkCallback (Method) GetEndpointsCallback (Method) IOPCUAClientMethodCallback (Interface) CallCallback (Method) IOPCUAClientMonitoredItemCallback (Interface) ItemEventCallback (Method) ItemParameterCallback (Method) ItemStateCallback (Method) ItemValueCallback (Method) IOPCUAClientSubscriptionCallback (Interface) ParameterChangeCallback (Method) StateChangeCallback (Method) IOPCUAClientViewCallback (Interface) BrowseCallback (Method) BrowseNextCallback (Method) RegisterNodesCallback (Method) TranslateBrowsePathsToNodeIdsCallback (Method) UnregisterNodesCallback (Method) Structs OPCAClientCredentials_UserPassword (Struct) OPCUAClientConnectionConfiguration (Struct) OPCUAClientCredentials (Union) OPCUAClientMonitoredItemConfiguration (Struct) OPCUAClientUserToken (Struct) Types OPCUAClientConnectionState (Enum) OPCUAClientMonitoredItemState (Enum) OPCUAClientSubscriptionState (Enum)

Interfaces ¶ IOPCUAClientConnectionCallback (Interface) ConnectionStateCallback (Method) GetUserCredentials (Method) VerifyServerCertificate (Method) IOPCUAClientDataAccessCallback (Interface) ReadCallback (Method) WriteCallback (Method) IOPCUAClientDiscoveryCallback (Interface) FindServersCallback (Method) FindServersOnNetworkCallback (Method) GetEndpointsCallback (Method) IOPCUAClientMethodCallback (Interface) CallCallback (Method) IOPCUAClientMonitoredItemCallback (Interface) ItemEventCallback (Method) ItemParameterCallback (Method) ItemStateCallback (Method) ItemValueCallback (Method) IOPCUAClientSubscriptionCallback (Interface) ParameterChangeCallback (Method) StateChangeCallback (Method) IOPCUAClientViewCallback (Interface) BrowseCallback (Method) BrowseNextCallback (Method) RegisterNodesCallback (Method) TranslateBrowsePathsToNodeIdsCallback (Method) UnregisterNodesCallback (Method)

IOPCUAClientConnectionCallback (ITF) ¶ INTERFACE IOPCUAClientConnectionCallback EXTENDS __SYSTEM.IQueryInterface This interface must be implemented to handle OPC UA connectin properly. It is used to inform the implementaiton on state changes of the UA connectin. Futher this interface is used to verify the OPC UA servers certificate and to retrieve the credentails used to activate the session. The callbacks are called when needed. The GetUserCredentials callback will not be called for connection using the AnonymousUserToken, as the VerifyServerCertificate callback will not be called for unprotected UA connections. Methods: ConnectionStateCallback GetUserCredentials VerifyServerCertificate Structure: ConnectionStateCallback (Method) GetUserCredentials (Method) VerifyServerCertificate (Method)

IOPCUAClientConnectionCallback.ConnectionStateCallback (METH) ¶ METHOD ConnectionStateCallback : OpcUa_StatusCode This callback is called whenever the state of the connection changes. InOut: Scope Name Type Comment Return ConnectionStateCallback OpcUa_StatusCode Input hConnection RTS_IEC_HANDLE Handle of the connection that changed the staet. connectionState OPCUAClientConnectionState The new connection state. reason OpcUa_StatusCode The reason why the connection state changed.

IOPCUAClientConnectionCallback.GetUserCredentials (METH) ¶ METHOD GetUserCredentials : OpcUa_StatusCode This callback is called when user credentials are needed to connect to the UA server. InOut: Scope Name Type Comment Return GetUserCredentials OpcUa_StatusCode Input hConnection RTS_IEC_HANDLE Handle to the UA connection. pUserToken POINTER TO OPCUAClientUserToken Pointer to the user token data structure that needs to be filled up. Don’t return your own pointer here.

IOPCUAClientConnectionCallback.VerifyServerCertificate (METH) ¶ METHOD VerifyServerCertificate : OpcUa_StatusCode This callback is used to allow a further verification of the UA servers certificate. There is no pre verification of the certificate against the certificate store of the PLC. InOut: Scope Name Type Comment Return VerifyServerCertificate OpcUa_StatusCode Any status code expect OpcUa_Good will cause the connection to be termindated. Input hConnection RTS_IEC_HANDLE Handle the the UA connection. hServerCertificate RTS_IEC_HANDLE Handle the UA server certificate. Can be used with any function of CmpX509Cert.