FC_Vector3DToString - General Information

Overview

Type:

Function

Available as of:

V1.0.0.0

Versions:

Current version

This chapter provides information on:

Description

Given an input 3D vector, the function returns a string structured as (X, Y, Z) and contains the elements of such vector.

In the conversion from LREAL to STRING the values are truncated to the third decimal.

Interface

Input

Data type

Description

i_stVector

SE_MATH.ST_Vector3D

A 3D vector.

Output

Data type

Description

q_xError

BOOL

If this output is set to TRUE, an error has been detected. For details, refer to q_etResult and q_etResultMsg.

q_etResult

ET_Result

Provides diagnostic and status information.

If q_xError = FALSE, then q_etResult provides status information.

If q_xError = TRUE, then q_etResult provides diagnostic/error information.

The enumeration ET_Result contains the possible values of the POU operation results.

q_sResultMsg

STRING[80]

Provides additional information about the current status of the POU.

Return Value

Data type

Description

STRING[255]

The function returns a string structured as (X, Y, Z) and contains the elements of an input 3D vector.

Diagnostic Messages

q_xError

q_etResult

Enumeration value

Description

FALSE

Ok

0

Success

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success