CmpTargetVisu Library Documentation ¶ Company System Title CmpTargetVisu Version 3.5.19.0 Categories System|SysLibs Author 3S-Smart Software Solutions GmbH Placeholder CmpTargetVisu Description 1 ¶ This library provides access to some functionality that is exported by the targetvisualization component Contents: ¶ Constants (GVL) EventIds (GVL) EventParameter EVTPARAM_Application (Struct) TargetVisuCyclic (Function) TargetVisuFindById (Function) TargetVisuNotify (Function) Indices and tables ¶ 1 Based on CmpTargetVisu.library, last modified 02.03.2023, 11:02:30. LibDoc 4.4.0.0-b.27 The content file CmpTargetVisu.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:02:32.
EventIds (GVL) ¶ InOut: Scope Name Type Initial Comment Constant CMPID_CmpTargetVisu DWORD 16#52 ComponentID to specify for EventOpen EVTPARAMID_CmpTargetVisu_WindowCreated WORD 16#1 IDs for the event parameter structures EVTVERSION_CmpTargetVisu_WindowCreated WORD 16#1 EVTPARAMID_CmpTargetVisu_WindowDestroyed WORD 16#1 EVTVERSION_CmpTargetVisu_WindowDestroyed WORD 16#1 EVTPARAMID_CmpTargetVisu_WindowFirstPaint WORD 16#1 EVTVERSION_CmpTargetVisu_WindowFirstPaint WORD 16#1 EVT_WindowCreated DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#3) <category>Events</category> <description>Event is sent when the target visu window is created</description> <param name=”pEventParam” type=”IN”>EVTPARAM_Application</param> EVT_WindowDestroyed DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#4) <category>Events</category> <description>Event is sent when the target visu window is destroyed</description> <param name=”pEventParam” type=”IN”>EVTPARAM_Application</param> EVT_WindowFirstPaint DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#5) <category>Events</category> <description>Event is sent when the target visu was painted the first time</description> <param name=”pEventParam” type=”IN”>EVTPARAM_Application</param>
Constants (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant NOTIFY_TAG_PAINTDATA_AVAILABLE DWORD 1 This tag can be sent to a targetvisualization instance to signal that new information is available that can be drawn from now on. This tag does not use the parameters at the moment.
EventParameter ¶ EVTPARAM_Application (Struct)
EVTPARAM_Application (STRUCT) ¶ TYPE EVTPARAM_Application : STRUCT <category>Event parameter</category> <element name=”pszApplication” type=”IN”>The name of the application that started the target visu window</element> InOut: Name Type pszApplication POINTER TO STRING
TargetVisuCyclic (FUN) ¶ FUNCTION TargetVisuCyclic : UDINT This function will be called cylically by the generic visualization libraries for active targetvisualization clients when it is supported by these libraries. The call is used for implementing a targetvisualization without the need for multitasking systems. InOut: Scope Name Type Comment Return TargetVisuCyclic UDINT Input dwTargetVisuHandle XWORD The handle of the targetvisualization instance that should be called.
TargetVisuFindById (FUN) ¶ FUNCTION TargetVisuFindById : SysTypes.RTS_IEC_RESULT This function can be used to find out the handle of the targetvisualization when having the according identification InOut: Scope Name Type Comment Return TargetVisuFindById SysTypes.RTS_IEC_RESULT Input dwExternId DWORD The identification used by the visualization to manage their different clients. Output hTargetVisu SysTypes.RTS_IEC_HANDLE
TargetVisuNotify (FUN) ¶ FUNCTION TargetVisuNotify : SysTypes.RTS_IEC_RESULT This function can be used to send notifications to a targetvisualization instance. As those notifications are usually sent in an asynchronous way, do not expect immediate effects when this function returned! InOut: Scope Name Type Comment Return TargetVisuNotify SysTypes.RTS_IEC_RESULT Input hTargetVisu SysTypes.RTS_IEC_HANDLE The handle of the targetvisualization dwTag DWORD The tag that signals which kind of information should be sent to the targetvisualization pParam POINTER TO BYTE This parameter can hold data that is related to the tag. The interpretation of this data depends on dwTag. It can as well be interpreted as a numeric (and thus non pointer) value
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:02:32 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpTargetVisu.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpTargetVisu.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 02.03.2023, 11:02:30 LibraryCategories library-category-list System|SysLibs Author string 3S-Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description Placeholder CmpTargetVisu Project CmpTargetVisu Title CmpTargetVisu Version version 3.5.19.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
