FB_ReceiveVisionDataServer - GetHeader (Method)

Overview

Type:

Method

Available as of:

V1.7.3.0

This chapter provides information on:

Task

Retrieve the header data of the vision protocol.

Description

With the method GetHeader, the header data of the vision protocol can be read.

Interface

Output

Data type

Description

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

ST_VisionDataHeader

Header data of the protocol.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

Ok

0

Ok

ExecutionAborted

NoDataAvailable

14

No data available.

NoDataAvailable

Enumeration name:

NoDataAvailable

Enumeration value:

14

Description:

No data available.

Issue

Cause

Solution

No data available.

There are no valid header data available.

Ensure that vision data is available by verifying xVisionDataReceived before calling the method.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

Status message: Reading the header data of the vision protocol was successful.