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.