CIFX_xChannelGetPacket (FUN) ¶ FUNCTION CIFX_xChannelGetPacket : RTS_IEC_RESULT InOut: Scope Name Type Return CIFX_xChannelGetPacket RTS_IEC_RESULT Input hChannel RTS_IEC_HANDLE udiSize UDINT pRecvPkt POINTER TO CIFX_PACKET udiTimeout UDINT
CIFX_xChannelGetPacketTimeout (FUN) ¶ FUNCTION CIFX_xChannelGetPacketTimeout : RTS_IEC_RESULT Sets the timeout of the packets sent to this channel InOut: Scope Name Type Comment Return CIFX_xChannelGetPacketTimeout RTS_IEC_RESULT Input hChannel RTS_IEC_HANDLE Channel Handle ulTimeout POINTER TO UDINT Timeout in ms
EVTPARAM_DownloadProgress (STRUCT) ¶ TYPE EVTPARAM_DownloadProgress : STRUCT InOut: Name Type Comment udiStep UDINT actual download step udiMaxStep UDINT maximal steps pUser UDINT user pointer udiError UDINT error code bFinished BOOL finish flag
EVTPARAM_PacketConfirmation (STRUCT) ¶ TYPE EVTPARAM_PacketConfirmation : STRUCT InOut: Name Type Comment hPkt CAA.Handle Handle of the confirmation packet udiPutInQueue UDINT Flag, if the packet should be placed in a queue or not. If it is 0, packet is discarded after this callback udiGenerateAsyncEvent UDINT Flag, if a asynchronous event should be generated (only with CAA Callback included) eAsyncEvent CB.EVENT CAA Callback event, which should be posted.
EVTPARAM_PacketIndication (STRUCT) ¶ TYPE EVTPARAM_PacketIndication : STRUCT InOut: Name Type Comment hPkt CAA.Handle Handle of the indication packet udiPutInQueue UDINT Flag, if the packet should be placed in a queue or not. If it is 0, packet is discarded after this callback udiGenerateAsyncEvent UDINT Flag, if a asynchronous event should be generated (only with CAA Callback included) eAsyncEvent CB.EVENT CAA Callback event, which should be posted.
EVTPARAM_PacketUnhandled (STRUCT) ¶ TYPE EVTPARAM_PacketUnhandled : STRUCT InOut: Name Type Comment pPkt POINTER TO CIFX_MAX_PACKET Pointer to the unhandled packet data pUser UDINT User pointer
EVTPARAM_UploadProgress (STRUCT) ¶ TYPE EVTPARAM_UploadProgress : STRUCT InOut: Name Type Comment udiStep UDINT actual upload step udiMaxStep UDINT maximal steps pUser UDINT user pointer udiError UDINT error code bFinished BOOL finish flag
EventIds (GVL) ¶ InOut: Scope Name Type Initial Comment Constant EVT_ID_DRV_BEFORE_CHECK_FIRMWARE UDINT 16#10001 IoDrvCIFX: Class Info, Evt ID 1. Event is send before netX firmware is checked. EVT_ID_CMP_DOWNLOAD_PROGRESS UDINT 16#10001 CmpHilscherCIFX: Class Info, Evt ID 1. Event is send for file download progress. EVT_ID_CMP_UPLOAD_PROGRESS UDINT 16#10002 CmpHilscherCIFX: Class Info, Evt ID 2. Event is send for file upload progress. EVT_ID_CMP_PACKET_UNHANDLED UDINT 16#10003 CmpHilscherCIFX: Class Info, Evt ID 3. Event is send for unhandled packets. EVT_ID_CMP_PACKET_INDICATION UDINT 16#10004 CmpHilscherCIFX: Class Info, Evt ID 4. Event is send for packet indications. EVT_ID_CMP_CARDS_INIT_DONE UDINT 16#10005 CmpHilscherCIFX: Class Info, Evt ID 5. Event is send after initialization of netX boards. No Parameters at the moment EVT_ID_CMP_PACKET_CONFIRMATION UDINT 16#10006 CmpHilscherCIFX: Class Info, Evt ID 6. Event is send for packet confirmations. CMPID_CmpHilscherCIFX UDINT 16#201 EVT_CIFX_GETFIRMWARE UDINT 16#1000A CmpHilscherCIFX: Class Info, Evt ID 10. Event is sent to configure the correct firmware to the corresponding card. EVTPARAMID_CIFX_GetFirmware WORD 16#4 EVTVERSION_CIFX_GetFirmware WORD 16#2 EVT_CIFX_LOADFIRMWARE UDINT 16#1000B CmpHilscherCIFX: Class Info, Evt ID 11. Event is send to load firmware dynamic. EVTPARAMID_CIFX_LoadFirmware WORD 16#5 EVTVERSION_CIFX_LoadFirmware WORD 16#1 EVT_CIFX_XCHANNEL_OPEN UDINT 16#1000C CmpHilscherCIFX: Class Info, Evt ID 12. Event is sent after a channel has been opened. EVTPARAMID_CIFX_xChannelOpen WORD 16#6 EVTVERSION_CIFX_xChannelOpen WORD 16#1 EVT_CIFX_XCHANNEL_CLOSE UDINT 16#1000D CmpHilscherCIFX: Class Info, Evt ID 13. Event is sent before a channel is closed. EVTPARAMID_CIFX_xChannelClose WORD 16#7 EVTVERSION_CIFX_xChannelClose WORD 16#1 EVT_ID_CMP_PACKET_INDICATION3 UDINT 16#1000E CmpHilscherCIFX: Class=Info, EventID=14. Event is send for packet indications without using the CAA queue! EVT_ID_CMP_PACKET_CONFIRMATION3 UDINT 16#1000F CmpHilscherCIFX: Class=Info, EventID=15. Event is send for packet confirmations without using the CAA queue! EVTPARAMID_CIFX_PacketParam WORD 16#8 EVTVERSION_CIFX_PacketParam WORD 16#1
Functions ¶ CIFX_GetBusActivationBeforeReset (Function) CIFX_ResetConfigApplication (Function) Channel CIFX_xChannelBusState (Function) CIFX_xChannelClose (Function) CIFX_xChannelCommonStatusBlock (Function) CIFX_xChannelConfigLock (Function) CIFX_xChannelControlBlock (Function) CIFX_xChannelDownload (Function) CIFX_xChannelExtendedStatusBlock (Function) CIFX_xChannelFindFirstFile (Function) CIFX_xChannelFindNextFile (Function) CIFX_xChannelGetMBXState (Function) CIFX_xChannelGetPacket (Function) CIFX_xChannelGetPacketTimeout (Function) CIFX_xChannelGetSendPacket (Function) CIFX_xChannelHostState (Function) CIFX_xChannelIOInfo (Function) CIFX_xChannelIORead (Function) CIFX_xChannelIOReadSendData (Function) CIFX_xChannelIOWrite (Function) CIFX_xChannelInfo (Function) CIFX_xChannelOpen (Function) CIFX_xChannelOpen2 (Function) CIFX_xChannelPLCActivateRead (Function) CIFX_xChannelPLCActivateWrite (Function) CIFX_xChannelPLCIsReadReady (Function) CIFX_xChannelPLCIsWriteReady (Function) CIFX_xChannelPLCMemoryPtr (Function) CIFX_xChannelPutPacket (Function) CIFX_xChannelReset (Function) CIFX_xChannelSetPacketTimeout (Function) CIFX_xChannelUpload (Function) CIFX_xChannelUserBlock (Function) CIFX_xChannelWatchdog (Function) Cifx_xChannelRegisterRecvCallback (Function) Driver CIFX_xDriverClose (Function) CIFX_xDriverEnumBoards (Function) CIFX_xDriverEnumChannels (Function) CIFX_xDriverGetErrorDescription (Function) CIFX_xDriverGetInformation (Function) CIFX_xDriverMemoryPointer (Function) CIFX_xDriverOpen (Function) CIFX_xMemCpy (Function) NETX_UDINT_TO_STRINGHEX (Function) SysDevice CIFX_xSysdeviceClose (Function) CIFX_xSysdeviceDownload (Function) CIFX_xSysdeviceFindFirstFile (Function) CIFX_xSysdeviceFindNextFile (Function) CIFX_xSysdeviceGetMBXState (Function) CIFX_xSysdeviceGetPacket (Function) CIFX_xSysdeviceInfo (Function) CIFX_xSysdeviceOpen (Function) CIFX_xSysdevicePutPacket (Function) CIFX_xSysdeviceReset (Function) CIFX_xSysdeviceUpload (Function)
CIFX_xMemCpy (FUN) ¶ FUNCTION CIFX_xMemCpy : POINTER TO BYTE <description> Copy the content from source (pSrc) to destination buffer (pDest). </description> <result><p>RESULT: Pointer to the destination buffer, where the copy was done.</p><result> InOut: Scope Name Type Comment Return CIFX_xMemCpy POINTER TO BYTE Input pDest POINTER TO BYTE <param name=”pDest” type=”IN”>Pointer to memory address to be copied to (target)</param> pSrc POINTER TO BYTE <param name=”pSrc” type=”IN”>Pointer to memory address to be copied from (source)</param> udiCount UDINT <param name=”udiCount” type=”IN”>Number of bytes to be copied</param>