IF_TargetsHandler - RemoveAllTargets (Method)

Overview

Type:	Method
Available as of:	V1.4.1.0

This chapter provides information on:

Task

Removes all targets from the list.

Description

The method RemoveAllTargets allows you to remove all targets from the list.

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.

Output

Data type

Description

q_etDiag

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

q_etDiagExt

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	Description
Ok	Ok	0	Ok
ExecutionAborted	NotConfigured	101	The function block is not configured yet.
ExecutionAborted	UnexpectedFeedback	4	Internal error detected.
ExecutionAborted	UpdateTargetsActive	109	An update of the target handler target is running and some methods cannot be called.

NotConfigured

Enumeration name:	NotConfigured
Enumeration value:	101
Description:	The function block is not configured yet.

Issue	Cause	Solution
Targets have not been removed from the targets handler.	The Configuration method has not been called yet.	Ensure that the Configuration method has been successfully called before calling this method.

Status Message: All the targets have been successfully removed from the targets handler.

UnexpectedFeedback

Issue	Cause	Solution
Targets have not been removed from the targets handler.	An unexpected condition occurred.	-

UpdateTargetsActive

Enumeration name:	UpdateTargetsActive
Enumeration value:	109
Description:	An update of the target handler targets is running and some method cannot be called.

Issue	Cause	Solution
Targets have not been removed from the targets handler.	It is not possible to remove a target from the targets handler while the UpdateTargets method is running.	Ensure that the UpdateTargets method is not running before calling this method.