IVisuStreamWriter (ITF) ¶ INTERFACE IVisuStreamWriter EXTENDS IVisuStreamHandler Implementors of this interface can be configured in the input action “File Transfer” in case of streaming data from the visualization to the plc Methods: Write EndOperation , inherited from IVisuStreamHandler StartOperation , inherited from IVisuStreamHandler Structure: Write (Method)
IVisuStreamWriter.Write (METH) ¶ METHOD Write : SysTypes.RTS_IEC_RESULT This method can be implemented for writing data to a stream like object. The return value can either be: ERR_OK: writing succeeded, nrBytes is > 0 ERR_PENDING: writing is temporarily not possible, udiNrBytes = 0 Any other error code: writing failed, reason see error code, udiNrBytes = 0 InOut: Scope Name Type Comment Return Write SysTypes.RTS_IEC_RESULT Input pbyBuffer POINTER TO BYTE A buffer where the data should be read from by the callee. The callee must always read from this buffer starting at offset 0. udiMaxNrBytes UDINT The maximal number of bytes that should be read from pbyBuffer by the callee. Output udiNrBytes UDINT The number of bytes that were written by the callee. A value of 0 signals an error happened.
IVisuManager2.CallOnAllVisus (METH) ¶ METHOD CallOnAllVisus InOut: Scope Name Type Input callee ICallOnVisuBlocks
IVisuManager2.GetRegisteredVisusBlockwise (METH) ¶ METHOD GetRegisteredVisusBlockwise : INT Will return the number of visualizations that have been copied to the array InOut: Scope Name Type Comment Return GetRegisteredVisusBlockwise INT Input pDataResult POINTER TO ARRAY [0..0] OF IVisualisation This array will be filled with all visualizations that are currently registered iSize INT The size of the array iStartIndex INT
IVisuManager3 (ITF) ¶ INTERFACE IVisuManager3 EXTENDS IVisuManager2 Like IVisuManager2: could be used by endusers too -> visible Methods: GetNextShownVisu GetPreviousShownVisu CallOnAllVisus , inherited from IVisuManager2 GetCurrentVisu , inherited from IVisuManager GetDialogManager , inherited from IVisuManager GetDialogManagerBase , inherited from IVisuManagerBase GetFrameManager , inherited from IVisuManager GetFrameManagerBase , inherited from IVisuManagerBase GetInternCommandManagerBase , inherited from IVisuManagerBase GetRegisteredVisus , inherited from IVisuManager GetRegisteredVisusBlockwise , inherited from IVisuManager2 GetVisuCount , inherited from IVisuManager LastMainVisu , inherited from IVisuManagerBase NextMainVisu , inherited from IVisuManagerBase RegisterVisu , inherited from IVisuManagerBase SetMainVisu , inherited from IVisuManagerBase SetMainVisuGlobally , inherited from IVisuManager SetStartVisu , inherited from IVisuManager UnregisterVisu , inherited from IVisuManagerBase Structure: GetNextShownVisu (Method) GetPreviousShownVisu (Method)
IVisuManager3.GetNextShownVisu (METH) ¶ METHOD GetNextShownVisu : IVisualisation For the given client: Returns the next visu to show, or null, if the visu is not known. InOut: Scope Name Type Return GetNextShownVisu IVisualisation Input pClientData POINTER TO VisuStructClientData
IVisuManager3.GetPreviousShownVisu (METH) ¶ METHOD GetPreviousShownVisu : IVisualisation For the given client: Returns the previous shown visu, or null, if still the first visu is shown. InOut: Scope Name Type Return GetPreviousShownVisu IVisualisation Input pClientData POINTER TO VisuStructClientData
IVisuUserEventManager.SetInputOnElementEventHandler (METH) ¶ METHOD SetInputOnElementEventHandler : BOOL This method assigns the eventhandler for input on element events. InOut: Scope Name Type Comment Return SetInputOnElementEventHandler BOOL TRUE - When there was no previous handler, i.e. the handler was registered successfully FALSE - When there was a previous event handler. Input itfInputOnElementEventHandler IInputOnElementEventHandler
IVisuUserEventManager.SetKeyEventHandler (METH) ¶ METHOD SetKeyEventHandler : BOOL This method assigns the eventhandler for key events. The method will return <c>TRUE</c> when there was no previous handler, and <c>FALSE</c> when there was a previous event handler. InOut: Scope Name Type Return SetKeyEventHandler BOOL Input handler IKeyEventHandler
IVisuUserEventManager.SetSpecialEventHandler (METH) ¶ METHOD SetSpecialEventHandler : BOOL This method assigns the eventhandler for mouse events. The method will return <c>TRUE</c> when there was no previous handler, and <c>FALSE</c> when there was a previous event handler. InOut: Scope Name Type Return SetSpecialEventHandler BOOL Input handler ISpecialEventHandler
