Generate and return .true.
if the attempt to (re)define the environment variable name
with the specified value
in the runtime shell **fails, otherwise return .false.
upon success.
- Parameters
-
[in] | name | : The input scalar character of default kind SK containing the name of the environment variable whose value should be retrieved from the runtime system shell.
The argument name must neither be empty nor all blank characters. |
[out] | value | : The output allocatable scalar character of default kind SK containing the value of the environment variable name .
The output value is guaranteed to capture the full value of the environment variable name and without any trailing blanks.
If the environment variable does not exist or a runtime error occurs, value will be allocated to empty string upon return. |
- Returns
failed
: The output scalar logical
of default kind LK.
It is .true.
if and only if an error occurs while defining the environment variable name
with the specified value
in the runtime shell.
Possible calling interfaces ⛓
logical(LK) :: failed
Generate and return .true. if the attempt to (re)define the environment variable name with the specif...
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
This module contains procedures and generic interfaces for inferring the runtime system shell type an...
- See also
- isFailedGetEnvVar
Example usage ⛓
11 character(:, SK),
allocatable :: name, value
13 type(display_type) :: disp
17 call disp%show(
"name = SK_''; value = SK_''")
18 name
= SK_
''; value
= SK_
''
19 call disp%show(
"isFailedPutEnvVar(name, value)")
24 call disp%show(
"name = SK_'PM'; value = SK_''")
25 name
= SK_
'PM'; value
= SK_
''
26 call disp%show(
"isFailedGetEnvVar(name, value)")
28 call disp%show(
"value ! `value` should be empty.")
29 call disp%show( value , deliml
= SK_
"""" )
30 call disp%show(
"isFailedPutEnvVar(name, SK_'ParaMonte')")
32 call disp%show(
"isFailedGetEnvVar(name, value)")
34 call disp%show(
"value ! `value` should be now `ParaMonte`.")
35 call disp%show( value , deliml
= SK_
"""" )
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
Generate and return failed = .false. if the value of the input environment variable name can be succe...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort
compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
2name
= SK_
''; value
= SK_
''
7name
= SK_
'PM'; value
= SK_
''
- Test:
- test_pm_sysShell
- Todo:
- Low Priority: A subroutine version of this functional interface could be implemented in future to avoid allocations and allow for non-default character kinds.
Final Remarks ⛓
If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.
-
If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
-
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.
- Copyright
- Computational Data Science Lab
- Author:
- Amir Shahmoradi, Tuesday March 7, 2017, 3:09 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin
Definition at line 505 of file pm_sysShell.F90.