DrvSafetyIoServices_Shm3S Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title DrvSafetyIoServices_Shm3S Version 1.5.0.0 Categories Intern|IoDrivers Namespace SafetyIoServices Author 3S - Smart Software Solutions GmbH Placeholder DrvSafetyIoServicesShm Description 1 ¶ This library offers read and write access to the shared memory provided by the safety runtime system. It implements the interface ISysSafetyIoServices. Contents: ¶ DrvSafetyIoServices_Shm3S Constants Function Blocks Structs Indices and tables ¶ 1 Based on DrvSafetyIoServices_Shm3S.library, last modified 12.12.2018, 14:39:50. LibDoc 4.4.0.0-b.27 The content file DrvSafetyIoServices_Shm3S.clean.json was generated with CODESYS V3.5 SP13 on 12.12.2018, 14:39:51.
DrvSafetyIoServices_Shm3S ¶ Constants Function Blocks SafetyIoServices (FunctionBlock) ISafetyIoServices Receive (Method) Send (Method) Structs SafetyIoServiceDiagnostics_Shm3S (Struct)
Constants ¶ All the three Global_Constants we have are for internal use only:
Function Blocks ¶ Currently there is only one FunctionBlock: SafetyIoServices (FunctionBlock) ISafetyIoServices Receive (Method) Send (Method)
SafetyIoServices (FB) ¶ FUNCTION_BLOCK SafetyIoServices IMPLEMENTS SafetyIoServicesItfs.ISafetyIoServices SafetyIoServices_Shm3S reads and writes F-Device-data to the SharedMemory (created by SRTS) and implements ISafetyIoServices this way. Used Libraries CmpErrors2 Interfaces (version via placeholder); using: Errors CmpLog (version via placeholder); using: LogOpen LogAdd2 LogClose Component Manager (version via placeholder); using: CMAddComponent DrvSafetyIoServices Interfaces (newest, implementing interface ISafetyIoServices) IoStandard (version via placeholder); using: IoConfigConnector IoConfigParameter ConfigGetParameter ConfigGetParameterValueDWord ConfigGetParameterValuePointer Standard (version via placeholder); using: CONCAT SysMem (version via placeholder); using: SysMemCpy SysShm (version via placeholder); using: SysSharedMemoryOpen2 SysSharedMemoryGetPointer SysSharedMemoryClose SysTypes2 Interfaces (version via placeholder); using: HandleConstants InOut: Scope Name Type Output Diag SafetyIoServiceDiagnostics_Shm3S Methods: Receive Send Structure: ISafetyIoServices Receive (Method) Send (Method)
IDatasourcesMgr.ReleaseData (METH) ¶ METHOD ReleaseData : SysTypes.RTS_IEC_RESULT Deactivates the item of the given instance path from monitoring. Note The items are reference counted so each call to IDatasourcesMgr.UseData or IDatasourcesMgr3.UseDataExpanding requires a matching call to ReleaseData InOut: Scope Name Type Comment Return ReleaseData SysTypes.RTS_IEC_RESULT Returns a runtime system error code (see CmpErrors.library) or one of Errors Input pstSymbol POINTER TO STRING The symbolic name of the variable to activate. Here the name of the variable on the local PLC/HMI is expected.
IDatasourcesMgr.SetCredentialsProvider (METH) ¶ METHOD SetCredentialsProvider : SysTypes.RTS_IEC_RESULT Assigns the given credentials provider object to all datasources. InOut: Scope Name Type Comment Return SetCredentialsProvider SysTypes.RTS_IEC_RESULT An error code representing the result of the operation Input provider ICredentialsProvider The object to assign
IDatasourcesMgr.UseData (METH) ¶ METHOD UseData : SysTypes.RTS_IEC_RESULT Activates the item of the given instance path for monitoring. Note The items are reference counted so each call to IDatasourcesMgr.UseData requires a matching call to IDatasourcesMgr.ReleaseData Note Usually items are monitored in total. If you want to expand the items (to prevent problems with different alignment etc.) then consider using the method IDatasourcesMgr3.UseDataExpanding instead. InOut: Scope Name Type Comment Return UseData SysTypes.RTS_IEC_RESULT Returns a runtime system error code (see CmpErrors.library) or one of Errors Input pstSymbol POINTER TO STRING The symbolic name of the variable to activate. Here the name of the variable on the local PLC/HMI is expected.
IDatasourcesMgr.WriteItemsSync (METH) ¶ METHOD WriteItemsSync : SysTypes.RTS_IEC_RESULT Writes the given list of items synchronously. Important Please remark that the operation might take quite some time in case many items are contained within the list. For this time, the call is blocking! InOut: Scope Name Type Comment Return WriteItemsSync SysTypes.RTS_IEC_RESULT Input items IDataItemList The list of items that have to be written
IDatasourcesMgr2 (ITF) ¶ INTERFACE IDatasourcesMgr2 EXTENDS IDatasourcesMgr Extension of IDatasourcesMgr supporting persistant item lists for preregistering lists of variables within connected devices. Properties: PersistantItemListCount Methods: AddNotificationClient CreatePersistantItemList DeletePersistantItemList GetPersistantItemList Lock RemoveNotificationClient Unlock ActionRecordDelete , inherited from IDatasourcesMgr ActionRecordReplay , inherited from IDatasourcesMgr ActionRecordingGetResult , inherited from IDatasourcesMgr ActionRecordingStart , inherited from IDatasourcesMgr AllItemsOk , inherited from IDatasourcesMgr BeginDataConfiguration , inherited from IDatasourcesMgr CreateItemList , inherited from IDatasourcesMgr DeleteItemList , inherited from IDatasourcesMgr EndDataConfiguration , inherited from IDatasourcesMgr GetDatasource , inherited from IDatasourcesMgr GetItemInfo , inherited from IDatasourcesMgr ReadItemsSync , inherited from IDatasourcesMgr ReleaseData , inherited from IDatasourcesMgr SetCredentialsProvider , inherited from IDatasourcesMgr UseData , inherited from IDatasourcesMgr WriteItemsSync , inherited from IDatasourcesMgr Structure: AddNotificationClient (Method) CreatePersistantItemList (Method) DeletePersistantItemList (Method) GetPersistantItemList (Method) Lock (Method) PersistantItemListCount (Property) RemoveNotificationClient (Method) Unlock (Method)