JCL Help:SetEnvironmentVar

 JCL Help: SetEnvironmentVar Function

SystemInformationRoutines.Environment

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Sets the value of an environment variable.

Pascal

 function SetEnvironmentVar(const Name: string; const Value: string): Boolean;

Parameters

Parameters	Description
const Name: string	Name of the environment variable to set.
const Value: string	New value for the specified environment variable.

Return Value

If the function succeeds it returns True, otherwise it returns False.

Description

SetEnvironmentVar sets the value of the specified environment variable to the supplied value. If the variable does not exists it is created first.

See Also

DelEnvironmentVar ExpandEnvironmentVar GetEnvironmentVar GetEnvironmentVars

About

Unit

JclSysInfo

Donator

Marcel van Brakel (Win32) André Snepvangers (Unix)

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository