IF_TargetsHandler - RemoveTarget (Method)

Overview

Type:	Method
Available as of:	V1.4.1.0

This chapter provides information on:

Removes one target from the list.

The method RemoveTarget allows you to remove one target from the list.

Input	Data type	Description
i_udiListIndex	UDINT	The index of the target to remove from the list.

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

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.

q_etDiag	q_etDiagExt	Enumeration value	Description
Ok	Ok	0	Ok
ExecutionAborted	NotConfigured	101	The function block is not configured yet.
ExecutionAborted	UpdateTargetsActive	109	An update of the target handler target is running and some methods cannot be called.
InputParameterInvalid	ListIndexInvalid	112	The provided list index is not referring to a valid target in the list.
InputParameterInvalid	ListIndexRange	111	The provided index is either zero or greater than the maximum list size.

Enumeration name:	ListIndexInvalid
Enumeration value:	112
Description:	The provided list index is not referring to a valid target in the list.

Issue	Cause	Solution
The target has not been removed from the targets handler.	The targets handler does not contain a target with the provided index.	Ensure that a target with index i_udiListIndex is contained in the list.

Enumeration name:	ListIndexRange
Enumeration value:	111
Description:	The provided index is either zero or greater than the maximum list size.

Issue	Cause	Solution
The target has not been removed from the targets handler.	The value of the index is out of range.	The value of the index must be within the range [1...Gc_udiMaxNumberOfTargets].

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

Issue	Cause	Solution
The target has 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: The target has been successfully removed from the targets handler.

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
The target has 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.