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.
IVisuStreamHandler (ITF) ¶ INTERFACE IVisuStreamHandler EXTENDS __SYSTEM.IQueryInterface This interface is the base interface of IVisuStreamReader and IVisuStreamWriter. Methods: EndOperation StartOperation Structure: EndOperation (Method) StartOperation (Method)
IVisuStreamHandler.EndOperation (METH) ¶ METHOD EndOperation This method will be called after a read or write operation on the current instance operation is finished or to cancel a not yet finished one. It is assumed that this call always succeeds. InOut: Scope Name Type Comment Input xCancel BOOL This value will be TRUE when the operation should be cancelled and FALSE if the call is only a notification about the end of the operation.
IVisuStreamHandler.StartOperation (METH) ¶ METHOD StartOperation : SysTypes.RTS_IEC_RESULT This method will be called when a read or write operation on the current instance operation is started. The return value can either be: ERR_OK: operation successfully started any other error code: starting an operation is not possible (at the moment) InOut: Scope Name Type Return StartOperation SysTypes.RTS_IEC_RESULT
IVisuUserEventManager.SetGestureEventHandler (METH) ¶ METHOD SetGestureEventHandler : BOOL This method assigns the eventhandler for gesture 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 SetGestureEventHandler BOOL Input handler IGestureEventHandler
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.SetMouseEventHandler (METH) ¶ METHOD SetMouseEventHandler : 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 SetMouseEventHandler BOOL Input handler IMouseEventHandler
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
IVisuUserEventManager.SetUserMgmtEventHandler (METH) ¶ METHOD SetUserMgmtEventHandler : BOOL This method assigns the eventhandler for user management events. InOut: Scope Name Type Comment Return SetUserMgmtEventHandler BOOL TRUE - When there was no previous handler, i.e. the handler was registered successfully FALSE - When there was a previous event handler. Input itfUserMgmtEventHandler IUserMgmtEventHandler