SNCM ECAT Slave Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title SNCM ECAT Slave Version 3.5.8.30 Categories Intern|Networking Namespace SNCM_ECATSLAVE Author 3S - Smart Software Solutions GmbH Placeholder SNCM_ECATSlave Description 1 ¶ 3S implementation of IEtcSlave Contents: ¶ _3S_SNCM_ECATSlave Function Blocks Indices and tables ¶ 1 Based on _3S_SNCM_ECATSlave.library, last modified 01.01.1601, 00:53:00. LibDoc 4.4.0.0-b.27 The content file _3S_SNCM_ECATSlave.clean.json was generated with CODESYS V3.5 SP10 Patch 2 on 18.05.2017, 08:41:52.
IDataServer5.Flags (PROP) ¶ PROPERTY Flags : DWORD
IDataServer5.GetRecordResult (METH) ¶ METHOD GetRecordResult : UDINT Returns the result of a record operation. For details <see>StartRecordMode</see>. The result of this operation (if successfull) will be returned in <see>result</see> InOut: Scope Name Type Return GetRecordResult UDINT Output result IDataServerActionRecord
IDataServer5.ReplayRecord (METH) ¶ METHOD ReplayRecord : UDINT Replays a previously recorded UseData/ReleaseData operation Calls to this method must be enclosed in <see>BeginDataConfiguration</see> and <see>EndDataConfiguration</see> InOut: Scope Name Type Return ReplayRecord UDINT Input record IDataServerActionRecord
IDataServer5.ResumeAfterTempShutdown (METH) ¶ METHOD ResumeAfterTempShutdown : UDINT This method can be called to resume the normal operation of a datasource after a call to <see>StartTempShutdown</see> Calls to this method must be protected by calling BeginDataConfiguration/EndDataConfiguration around this call. InOut: Scope Name Type Comment Return ResumeAfterTempShutdown UDINT Input pstDataSource POINTER TO STRING The name of the datasource, must not be NULL
IDataServer5.StartRecordMode (METH) ¶ METHOD StartRecordMode : UDINT Clients of the dataserver can call this method to start recording the following actions (UseData, ReleaseData). In between calls to this method and the according call to <see>GetRecordResult</see> no real action will be done. Instead the action will only be recorded. The result can be retrieved using <see>GetRecordResult</see>. InOut: Scope Name Type Return StartRecordMode UDINT
IDataServer5.StartTempShutdown (METH) ¶ METHOD StartTempShutdown : UDINT This method can be used for temporarily shutting down a dataserver connection. Due to the reason that this shutdown might take some cycles, the user of this method should wait until the operation is finished. This can be determined using the callback <see>cbShutdownDone</see>. Calls to this method must be protected by calling BeginDataConfiguration/EndDataConfiguration around this call. To resume the normal operation of the datasource call the method <see>ResumeAfterTempShutdown</see>. InOut: Scope Name Type Comment Return StartTempShutdown UDINT Input pstDataSource POINTER TO STRING The name of the datasource, must not be NULL cbShutdownDone ICallback An optional callback that will be triggered when the shutdown is finished. The callback parameter will be a pointer to a <see>ITempShutdownResult</see>. Please remember that the callback might be called from a different task then the call to <see>StartTempShutdown</see>. Please remember that the given object must live at least until the callback is called. Don’t pass a function local variable for this parameter!
IDataServer6 (ITF) ¶ INTERFACE IDataServer6 EXTENDS IDataServer5 Enhancement of interface IDataServer5 for retrieving alarm from the alarm storage Properties: Flags , inherited from IDataServer5 InstancePathPrefix , inherited from IDataServer2 Methods: GetAddress IsSwappingNeeded ProcessDataServerRequest AllItemsOk , inherited from IDataServer BeginDataConfiguration , inherited from IDataServer CreateItemList , inherited from IDataServer4 DeleteItemList , inherited from IDataServer4 DeleteRecord , inherited from IDataServer5 EndDataConfiguration , inherited from IDataServer GetInterface , inherited from IDataServer2 GetItemInfo , inherited from IDataServer GetRecordResult , inherited from IDataServer5 ReadItems , inherited from IDataServer4 ReleaseData , inherited from IDataServer ReplayRecord , inherited from IDataServer5 ResolveSymbol , inherited from IDataServer3 ResumeAfterTempShutdown , inherited from IDataServer5 SetCredentialsProvider , inherited from IDataServer2 StartRecordMode , inherited from IDataServer5 StartTempShutdown , inherited from IDataServer5 UseData , inherited from IDataServer WriteItems , inherited from IDataServer4 Structure: GetAddress (Method) IsSwappingNeeded (Method) ProcessDataServerRequest (Method)
IDataServer6.GetAddress (METH) ¶ METHOD GetAddress : UDINT Determines the address info of an item. InOut: Scope Name Type Comment Return GetAddress UDINT Input pstSymbol POINTER TO STRING The fully qualified path to the item, e.g. ‘Remote_Device.Application.PLC_PRG.iSchlurpsknurps’ Output address PlcAddressInfoUnion
IDataServer6.IsSwappingNeeded (METH) ¶ METHOD IsSwappingNeeded : SwappingInfo This method determines, whether the data server swaps the data it read from the remote device. InOut: Scope Name Type Comment Return IsSwappingNeeded SwappingInfo Input sName STRING The fully qualified name of the application on the remote device
