ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_sysShell::isFailedPutEnvVar Interface Reference

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.
More...

Detailed Description

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 ⛓

use pm_sysShell, only: isFailedPutEnvVar
use pm_kind, only: LK
logical(LK) :: failed
failed = isFailedPutEnvVar(name, value)
pm_sysShell::isFailedPutEnvVar
Generate and return .true. if the attempt to (re)define the environment variable name with the specif...
Definition: pm_sysShell.F90:505
pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
pm_sysShell
This module contains procedures and generic interfaces for inferring the runtime system shell type an...
Definition: pm_sysShell.F90:38
Remarks
The procedures under discussion are impure.
See also
isFailedGetEnvVar


Example usage ⛓

1program example
2
3 use pm_kind, only: LK, IK, SK
4 use pm_io, only: display_type
5 use pm_sysShell, only: isFailedPutEnvVar
6 use pm_sysShell, only: isFailedGetEnvVar
7
8 implicit none
9
10 logical(LK) :: failed
11 character(:, SK), allocatable :: name, value
12
13 type(display_type) :: disp
14 disp = display_type(file = "main.out.F90")
15
16 call disp%skip()
17 call disp%show("name = SK_''; value = SK_''")
18 name = SK_''; value = SK_''
19 call disp%show("isFailedPutEnvVar(name, value)")
20 call disp%show( isFailedPutEnvVar(name, value) )
21 call disp%skip()
22
23 call disp%skip()
24 call disp%show("name = SK_'PM'; value = SK_''")
25 name = SK_'PM'; value = SK_''
26 call disp%show("isFailedGetEnvVar(name, value)")
27 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')")
31 call disp%show( isFailedPutEnvVar(name, SK_'ParaMonte') )
32 call disp%show("isFailedGetEnvVar(name, value)")
33 call disp%show( isFailedGetEnvVar(name, value) )
34 call disp%show("value ! `value` should be now `ParaMonte`.")
35 call disp%show( value , deliml = SK_"""" )
36 call disp%skip()
37
38end program example
pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
pm_sysShell::isFailedGetEnvVar
Generate and return failed = .false. if the value of the input environment variable name can be succe...
Definition: pm_sysShell.F90:426
pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
pm_kind::IK
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
pm_kind::SK
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
pm_io::display_type
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output ⛓
1
2name = SK_''; value = SK_''
3isFailedPutEnvVar(name, value)
4T
5
6
7name = SK_'PM'; value = SK_''
8isFailedGetEnvVar(name, value)
9F
10value ! `value` should be empty.
11" "
12isFailedPutEnvVar(name, SK_'ParaMonte')
13F
14isFailedGetEnvVar(name, value)
15F
16value ! `value` should be now `ParaMonte`.
17"ParaMonte"
18
19
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.

  1. 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.
  2. 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 at Austin

Definition at line 505 of file pm_sysShell.F90.

The documentation for this interface was generated from the following file: