MapErrorCode (FUN) ¶ FUNCTION MapErrorCode : SysTypes.RTS_IEC_RESULT InOut: Scope Name Type Return MapErrorCode SysTypes.RTS_IEC_RESULT Input err PLCH.Error
MapErrorCodeFailedAsConnLost (FUN) ¶ FUNCTION MapErrorCodeFailedAsConnLost : SysTypes.RTS_IEC_RESULT At the moment the PLCHandler returns only Failed in case of a connection loss when waiting for a service In situations where we expect this behaviour, this method can be called which will then return a more specific error code. InOut: Scope Name Type Return MapErrorCodeFailedAsConnLost SysTypes.RTS_IEC_RESULT Input err PLCH.Error
PlcHandlerAccess ¶ AsyncBase (FunctionBlock) CanTrigger (Method) FB_Init (Method) JoinLastAction (Method) LastActionCompleted (Property) LastActionFailed (Property) Reset (Method) TriggerCall (Method) TriggerCallWithTaskInfo (Method) AsyncWrapper (FunctionBlock) Connect (Method) DefineVarList (Method) Disconnect (Method) Init (Method) ReleaseRequest (Method) SyncDefineVarList (Method) SyncReadVarList (Method) SyncReadVarListFromPlc (Method) SyncReadVars (Method) SyncSendService (Method) SyncWriteVarListToPlc (Method) TriggerConnect (Method) TriggerDefineVarList (Method) TriggerDisconnect (Method) TriggerReleaseRequest (Method) TriggerSyncDefineVarList (Method) TriggerSyncReadVarList (Method) TriggerSyncReadVarListFromPlc (Method) TriggerSyncReadVars (Method) TriggerSyncSendService (Method) TriggerSyncWriteVarListToPlc (Method)
RuntimeCredentialsHandler (FB) ¶ FUNCTION_BLOCK RuntimeCredentialsHandler A utility function block for the work with credentials, storing them at the correct location in the INI-String and resetting them both in the caller and after usage in the INI-String InOut: Scope Name Type Comment Input pIniString POINTER TO BYTE The ini-string that should be modified at need xAssignCredentials BOOL Whether the fb should become active or not xResetPassedCredentials BOOL could become an option in the future whether credentials should be asked on every connection; for now we use the same behaviour than dataserver (keeping credentials) Inout userName STRING The username to write to ini; will be resetted after writing to ini (thus VAR_IN_OUT) password STRING The username to write to ini; will be resetted after writing to ini (thus VAR_IN_OUT) Output error SysTypes.RTS_IEC_RESULT Methods: ResetIniContent Structure: ResetIniContent (Method)
GlobalVariables ¶ GVL (GVL) GVL_EarlyInit (GVL)
GVL (GVL) ¶ Attributes: qualified_only InOut: Name Type logger Logger alloc Allocator
GVL_EarlyInit (GVL) ¶ Attributes: qualified_only InOut: Name Type Comment applicationName STRING _appNameHelper AppNameHelper only for automatic assignment of applicationName
Structs ¶ ConnectionSetup (Struct) DriverCfg (Struct)
ConnectionSetup (STRUCT) ¶ TYPE ConnectionSetup : STRUCT This structure contains all the data for dynamic connection setup IEC application has to instantiate it to allow a dynamic change of parameterss InOut: Name Type Comment xDataValid BOOL If the data are valid stIpAddress STRING Data to set when ‘CODESYS V3’ or ‘CODESYS V3 via Gateway’ connections have been selected at design time stPort STRING Port: e.g. ‘1234’ stGatewayAddress STRING Data to set when ‘CODESYS V3 via Gateway’ access has been selected at design time stGatewayPort STRING Gateway port: e.g. ‘1234’ stDeviceName STRING Data to set when ‘CODESYS V3’ or ‘CODESYS V3 via Gateway’ connections have been selected at design time and “node name” or “node address” are used If present, this parameter has priority on IP address parameters
DriverCfg (STRUCT) ¶ TYPE DriverCfg : STRUCT Driver configuration structure InOut: Name Type Comment pstIniContent POINTER TO STRING(InternalConstants.IniStringPtrSize) xCredentialsAtRuntime BOOL Initialization string for PLCHandler pConnectionSetup POINTER TO ConnectionSetup If the credentials have to be used
