CmpChannelClientIec Library Documentation ¶ Company System Title CmpChannelClientIec Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpChannelClientIec Description 1 ¶ This library provides access to the channel client functionality if it is included in a runtime system. Using this functionality, one runtime can talk to another runtime using the codesys protocol. Contents: ¶ Constants (GVL) NetClientCloseChannel (Function) NetClientOpenChannel (Function) NetClientOpenChannelResult (Function) NetClientSend (Function) ReturnValues (GVL) Structures CHCAddressComponent (Struct) CHCAddressType (Enum) CHCPeerAddress (Struct) CHCProtocolDataUnit (Struct) Test HandleChannelError (Function) HandleReply (Function) SetError (Function) Test_PRG (Program) Test_State (Enum) Indices and tables ¶ 1 Based on CmpChannelClientIec.library, last modified 20.04.2021, 15:36:44. LibDoc 4.4.0.0-b.27 The content file CmpChannelClientIec.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:36:44.
Constants (GVL) ¶ InOut: Scope Name Type Initial Constant MAX_NODE_ADDR_LEN INT 16#F
NetClientCloseChannel (FUN) ¶ FUNCTION NetClientCloseChannel : UDINT InOut: Scope Name Type Return NetClientCloseChannel UDINT Input wChannelHandle WORD
NetClientOpenChannelResult (FUN) ¶ FUNCTION NetClientOpenChannelResult : UDINT InOut: Scope Name Type Return NetClientOpenChannelResult UDINT Input dwRequestId DWORD pwChannelHandle POINTER TO WORD pdwCommBufferSize POINTER TO DWORD pbBigEndianByteOrder POINTER TO BOOL
NetClientOpenChannel (FUN) ¶ FUNCTION NetClientOpenChannel : UDINT InOut: Scope Name Type Comment Return NetClientOpenChannel UDINT Input addr CHCPeerAddress dwCommBuffSize DWORD pdwReqId POINTER TO DWORD pfnReceiveCallback POINTER TO BYTE Prototype see NetClientReplyReceivedProc pfnChannelErrorCallback POINTER TO BYTE Prototype see NetClientOpenChannelResult
NetClientSend (FUN) ¶ FUNCTION NetClientSend : UDINT InOut: Scope Name Type Return NetClientSend UDINT Input wChannelHandle WORD data CHCProtocolDataUnit
ReturnValues (GVL) ¶ InOut: Scope Name Type Initial Comment Constant ERR_OK UDINT 16#0 ERR_FAILED UDINT 16#FFFFFFFF ERR_NOBUFFER UDINT 16#6 ERR_PENDING UDINT 16#A ERR_CHC_CHINVALID UDINT 16#1A1 Channel Id invalid ERR_CHC_TIMEOUT UDINT 16#1A2 Channel closed or connect failed due to a timeout ERR_CHC_PROTOCOL UDINT 16#1A3 Protocol error ERR_CHC_CHECKSUM UDINT 16#1A4 Inrecoverable transmission error (checksum) etc. ERR_CHC_MODEHOST UDINT 16#1A5 The client application tried to send a message although the channel is in receive mode ERR_CHC_MODEPEER UDINT 16#1A6 Incoming message although the channel is in send mode. ERR_CHC_NUMCHANNELS UDINT 16#1A7 No more channels available. ERR_CHC_CLOSED UDINT 16#1A8 Channel closed by peer ERR_CHC_MESSAGESIZE UDINT 16#1A9 Message exceeds the commbuffer size ERR_CHC_NOCHBUFFER UDINT 16#1AA Not enough memory to provide the required communication buffer
Structures ¶ CHCAddressComponent (Struct) CHCAddressType (Enum) CHCPeerAddress (Struct) CHCProtocolDataUnit (Struct)
CHCAddressComponent (STRUCT) ¶ TYPE CHCAddressComponent : STRUCT InOut: Name Type Components ARRAY [0..1] OF BYTE
CHCAddressType (ENUM) ¶ TYPE CHCAddressType : InOut: Name Initial Absolute 0 Relative 1
