Subroutine Type

Utility/Data Access

Definition

Retrieves values stored in a Reference_String entity.

Use

The function can be called by any user-defined subroutine.

Calling Syntax

Fortran

CALL GTSTRG(ID, STRING, NCHARS, ISTAT)

C

c_gtstrg(id, string, nchars, istat)

Python

[string, istat] = py_gtstrg(ID)

MATLAB

[string, istat] = m_gtstrg(ID)

Input Arguments

[integer] ID

The identifier of the corresponding Reference_String.

Only for C/C++:

Output Values

[character*(*)] STRING

A character string or a string variable that contains the requested string.

[int] ISTAT

A flag that indicates the success of the GTSTRG operation.

[int] NCHARS

A scalar value that indicates the number of characters of the returned string.