IF_EntitiesHandler - GetTargetType (Method)

Overview

Type:	Method
Available as of:	V1.4.1.0

This chapter provides information on:

Retrieve the information on a target type.

The method GetTargetType is used to retrieve the information on a target type previously stored inside the internal list of the function block.

Input	Data type	Description
i_etType	ET_TargetType	An ID used to unequivocally identify a target type in the system. Admissible values are in the range ET_TargetType.Type1...ET_TargetType.Type20.

Input

Data type

Description

i_etType

ET_TargetType

An ID used to unequivocally identify a target type in the system.

Admissible values are in the range ET_TargetType.Type1...ET_TargetType.Type20.

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.

Data type	Description
ST_TargetTypeData	Returns a data structure containing information on a selected target type, previously stored inside the function block.

q_etDiag	q_etDiagExt	Enumeration value of q_etDiagExt	Description
Ok	Ok	0	Ok
InputParameterInvalid	TargetTypeInvalid	134	A provided target type is invalid.
InputParameterInvalid	TargetTypeUnknown	136	A provided target type is invalid.

Status message: A target type has been successfully retrieved from the list

Enumeration name:	TargetTypeInvalid
Enumeration value:	134
Description:	A provided target type is invalid.

Issue	Cause	Solution
A target type has not been successfully retrieved from the list.	i_etType contains an invalid target type.	Ensure that the value of i_etType refers to a target type in the range ET_TargetType.Type1... ET_TargetType.Type20.

Enumeration name:	TargetTypeUnknown
Enumeration value:	136
Description:	A provided target type is invalid.

Issue	Cause	Solution
A target type has not been retrieved successfully from the list.	i_etType contains an indeterminable target type.	Ensure that the value of i_etType refers to a previously configured target type.