FB_SendVisionDataClient - SetAdditionalString (Method)

Overview

Type:	Method
Available as of:	V1.7.3.0

This chapter provides information on:

Task
Description
Interface
Diagnostic Messages

Task

Add an additional string to the vision protocol.

Description

With the method SetAdditionalString, an additional string can be added to the vision protocol.

Interface

Input	Data type	Description
i_sString	STRING[80]	Additional string of the protocol.

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.

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.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value of q_etDiagExt	Description
Ok	Ok	0	Ok
Ok	NoDataAvailable	14	No data available.
ExecutionAborted	AdditionalStringAlreadySet	31	The additional string is already set.
LimitReached	ProtocolLengthExceeded	15	The length of the protocol has been exceeded.

AdditionalStringAlreadySet

Enumeration name:	AdditionalStringAlreadySet
Enumeration value:	31
Description:	Additional string is already set.

Issue	Cause	Solution
Additional string is already set.	The additional string was already set.	Verify that the header data is not set twice. Send the data before setting the additional string again.

Issue

Cause

Solution

Additional string is already set.

The additional string was already set.

Verify that the header data is not set twice.

Send the data before setting the additional string again.

NoDataAvailable

Enumeration name:	NoDataAvailable
Enumeration value:	14
Description:	No data available.

Issue	Cause	Solution
No header data available.	Product data can only be set after header data has been set.	Verify that the method SetHeader(...) was called successfully before setting product data.

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Success

Status message: Adding an additional string to the vision protocol was successful.

ProtocolLengthExceeded

Enumeration name:	ProtocolLengthExceeded
Enumeration value:	15
Description:	The length of the protocol has been exceeded.

Issue	Cause	Solution
The length of the protocol has been exceeded.	The length of the protocol to send to the server exceeds the value of Gc_uiMaxLengthOfProtocol.	Adapt the parameter Gc_uiMaxLengthOfProtocol. Split the content of the protocol and send it in several protocols.

Issue

Cause

Solution

The length of the protocol has been exceeded.

The length of the protocol to send to the server exceeds the value of Gc_uiMaxLengthOfProtocol.

Adapt the parameter Gc_uiMaxLengthOfProtocol.

Split the content of the protocol and send it in several protocols.