VSS.Environments

Entities

Tagged Types

• Process_Environment

Subprograms

• Contains
• Value
• Value_Paths

Description

Copyright (C) 2022, AdaCore

SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

Contains

function Contains
  (Self : Process_Environment'Class;
   Name : VSS.Strings.Virtual_String) return Boolean

Return True when environment variable with the given name is set in the environment.

Parameters

Self

Name

Return Value

Process_Environment

type Process_Environment is tagged private;

Value

function Value
  (Self    : Process_Environment'Class;
   Name    : VSS.Strings.Virtual_String;
   Default : VSS.Strings.Virtual_String := VSS.Strings.Empty_Virtual_String)
   return VSS.Strings.Virtual_String

Return value of the environment variable with the given name or given default value otherwise.

Parameters

Self

Name

Default

Return Value

Value_Paths

function Value_Paths
  (Self             : Process_Environment'Class;
   Name             : VSS.Strings.Virtual_String;
   Keep_Empty_Paths : Boolean                                  := True;
   Default          : VSS.String_Vectors.Virtual_String_Vector :=
     VSS.String_Vectors.Empty_Virtual_String_Vector)
   return VSS.String_Vectors.Virtual_String_Vector

Return value of the environment variable with the given name if defined, otherwise return given default value. Value of the environment variable is split into the vector with platform specific separator (':' on POSIX and ';' on Windows).

Parameters

Self

Name

Keep_Empty_Paths

Default

Return Value