CDSV3ProtocolUtils Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title CDSV3ProtocolUtils Version 4.1.0.0 Categories Intern|DataSources Namespace CDSV3Prot Author 3S - Smart Software Solutions GmbH Placeholder CDSV3ProtocolUtils Description 1 ¶ This library contains interfaces and function blocks used to build up the layer 7 communication protocol of CODESYS. Contents: ¶ BuildAndEnqueueV3Request (Function) Constants (GVL) Errors (GVL) ICDSV3RequestBuilder (Interface) BuildRequest (Method) GetDataBuffer (Method) GetDataBufferSize (Method) GetService (Method) GetServiceGroup (Method) RequestEnqueued (Method) ICDSV3RequestCallback (Interface) SetTargetByteorder (Method) IRequestResult (Interface) IsReplyPending (Method) SetReplyPending (Method) IServiceReader (Interface) GetContent (Method) GetContentSize (Method) GetUnreadContent (Method) GetUnreadContentSize (Method) IgnoreBytes (Method) IsDataTag (Property) MoveDown (Method) MoveNext (Method) MoveNextConditional (Method) MoveUp (Method) ReadByte (Method) ReadBytes (Method) ReadBytesSwapped (Method) ReadDWord (Method) ReadLWord (Method) ReadString (Method) ReadWString (Method) ReadWord (Method) TagId (Property) ValidTag (Property) IServiceWriter (Interface) AppendRaw (Method) WriteByte (Method) WriteBytes (Method) WriteBytesSwapped (Method) WriteComplexStartTag (Method) WriteDWord (Method) WriteDWordSwapped (Method) WriteDataStartTag (Method) WriteEndTag (Method) WriteFillBytes (Method) WriteLWord (Method) WriteLWordSwapped (Method) WritePString (Method) WriteString (Method) WriteWord (Method) WriteWordSwapped (Method) Intern Utilities ProtocolDataUnit (Struct) ServiceHeader (Struct) ServiceReader (FunctionBlock) Alive (Property) Create (Method) CreateDynamic (Method) Destroy (Method) FB_Exit (Method) ITaggedServiceReader ServiceRequest (FunctionBlock) Create (Method) FB_Exit (Method) RestoreSavepoint (Method) StoreSavepoint (Method) Writer (Property) override ServiceRequestBase (FunctionBlock) ContentPtr (Property) Create (Method) Data (Property) DataValid (Property) FB_Exit (Method) Finish (Method) HaveToSwap (Property) Header (Property) abstract ServiceRequestRaw (FunctionBlock) RawData (Property) override ServiceResponse (FunctionBlock) ContentData (Property) ContentSize (Property) Create (Method) CreatePDU (Method) Destroy (Method) FB_Exit (Method) Header (Property) Reader (Property) private ServiceWriter (FunctionBlock) Alive (Property) Create (Method) CreateDynamic (Method) Destroy (Method) FB_Exit (Method) Finish (Method) Handle (Property) ITaggedServiceWriter ServiceWriterSavepoint (FunctionBlock) FB_Exit (Method) FreeSavepoint (Method) Init (Method) Restore (Method) Store (Method) Utilities UtilGetLocalByteorder (Function) UtilGetLocalByteorderAtRuntime (Function) UtilIsGeneralErrorReply (Function) UtilIsIntelByteorder (Function) UtilIsToSwap (Function) UtilsWriteBYTE (Function) UtilsWriteString (Function) UtilsWriteUDINT (Function) UtilsWriteUINT (Function) UtilsWriteULINT (Function) Indices and tables ¶ 1 Based on CDSV3ProtocolUtils.library, last modified 14.02.2022, 17:44:06. LibDoc 4.4.0.0-b.27 The content file CDSV3ProtocolUtils.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 14.02.2022, 17:44:06.

BuildAndEnqueueV3Request (FUN) ¶ FUNCTION BuildAndEnqueueV3Request : UDINT This function can be used to build a CDSV3 request and enqueue it in a given datasource. InOut: Scope Name Type Comment Return BuildAndEnqueueV3Request UDINT An UDINT representing the error code of the processing. 0 in case of success Input itfDatasource IDatasources.IDatasource An instance of IDatasource, where the request will be enqueued. itfCDSV3RequestBuilder ICDSV3RequestBuilder An instance of ICDSV3RequestBuilder, that is able to build the request itfRequestCallback IDatasources.ICustomRequestCallback An instance of ICustomRequestCallback, that will be informed if the result of the request is available Output eRemoteByteorder IDatasources.ByteOrder Returns the byte order of the PLC to which the request will be sent xHasToSwap BOOL Returns TRUE if the PLC to which the request will be sent has a different byte order itfCDSV3Request IDatasources.ICDSV3Request Returns the ICDSV3Request instance, that has to be released after the result was retrieved (in method RequestFinished by calling ICDSV3RequestHandling.ReleaseRequest)

Constants (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Constant HeaderTagStandard UINT 16#CD55 TAG_GeneralError UINT 16#FF7F TAG_ExtendedErrorInfo UINT 16#FF7E

Errors (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant ERR_PLCS_UNKNOWN_PROTOCOL UDINT 16#1011 ERR_PLCS_ALIGNMENT UDINT 16#1010 ERR_TSW_NOTCREATED UDINT 16#1000 ERR_TSR_NOMORETAGS UDINT 16#1040 ERR_TSR_NOCONTAINERTAG UDINT 16#1041 ERR_TSR_NODATATAG UDINT 16#1042 ERR_TSR_ENDOFTAG UDINT 16#1043 ERR_TSR_READONWRONGTAG UDINT 16#1044 ERR_TSR_NOTCREATED UDINT 16#1045 The service reader object was not created completely or not created at all

ICDSV3RequestBuilder (ITF) ¶ INTERFACE ICDSV3RequestBuilder This interface is implemented by function blocks, that are able to build the CDSV3 service requests Methods: BuildRequest GetDataBuffer GetDataBufferSize GetService GetServiceGroup RequestEnqueued Structure: BuildRequest (Method) GetDataBuffer (Method) GetDataBufferSize (Method) GetService (Method) GetServiceGroup (Method) RequestEnqueued (Method)

ICDSV3RequestBuilder.BuildRequest (METH) ¶ METHOD BuildRequest : UDINT Method is called to build the request. InOut: Scope Name Type Comment Return BuildRequest UDINT The error code Input itfServiceWriter IServiceWriter An instance of IServiceWriter, that has to be used to build the request xHasToSwap BOOL TRUE if the PLC the request will be sent to, has a different byte order

ICDSV3RequestBuilder.GetDataBuffer (METH) ¶ METHOD GetDataBuffer : POINTER TO BYTE Returns a pointer to the buffer, where the request to send to the PLC will be built InOut: Scope Name Type Return GetDataBuffer POINTER TO BYTE

ICDSV3RequestBuilder.GetDataBufferSize (METH) ¶ METHOD GetDataBufferSize : UDINT Returns the size of the buffer, that is returned by method GetDataBuffer InOut: Scope Name Type Return GetDataBufferSize UDINT

ICDSV3RequestBuilder.GetService (METH) ¶ METHOD GetService : UINT Returns the service identifying the request InOut: Scope Name Type Comment Return GetService UINT an UINT representing the service

ICDSV3RequestBuilder.GetServiceGroup (METH) ¶ METHOD GetServiceGroup : UINT Returns the service group the request belongs to InOut: Scope Name Type Comment Return GetServiceGroup UINT an UINT representing the service group