GTSTRG

Utility/Data Access SubroutineRetrieves values stored in a Reference_String entity.

Use

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

Format

Fortran Calling Syntax
CALL GTSTRG(ID, STRING, NCHARS, ISTAT)
C/C++ Calling Syntax
c_gtstrg(id, string, nchars, istat)
Python Calling Syntax
[string, istat] = py_gtstrg(ID)
MATLAB Calling Syntax
[string, istat] = m_gtstrg(ID)

Attributes

ID
[integer]
The identifier of the corresponding Reference_String.
Only for C/C++.

Output

STRING
[character*(*)]
A character string or a string variable that contains the requested string.
ISTAT
[integer]
A flag that indicates the success of the GTSTRG operation.
0
Success
-2
Reference_Array was not found.
NCHARS
[integer]
A scalar value that indicates the number of characters of the returned string.