FB_ReceiveVisionData - GetVisionString (Method)

Overview

Type:

Method

Available as of:

V1.5.0.0

This chapter provides information on:

oTask

oDescription

oInterface

oReturn Value

oDiagnostic Messages

Task

Retrieve the vision string.

Description

With the method GetVisionString, the received vision string can be read.

In case the string is longer than 80 bytes, the method must be called several times and you must save the part(s) of the string. If the end of the string is reached, q_xEndOfString is set to TRUE.

Interface

Output

Data type

Description

q_xEndOfString

BOOL

TRUE: The entire vision string was read or the vision string is empty.

FALSE: The vision string is longer than STRING[80]. The method must be called again to read the entire vision string.

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic. A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Diagnostic message

q_sMsg

STRING[80]

Event-triggered message that gives more detailed information on the diagnostic state.

Return Value

Data type

Description

STRING[80]

Received vision string.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

Ok

0

Ok

EmptyString

71

The vision string is empty.

EmptyString

Enumeration name:

EmptyString

Enumeration value:

71

Description:

The vision string is empty.

Status message: The vision string is empty.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Status message: Reading the vision string was successful.