Environment Variable

<< Click to Display Table of Contents >>

Navigation:  PDF-XChange Editor V9 User Manual > Appendix > Macros >

Environment Variable


 

editor.icon Environment Variable

 


 

The Environment Variable macro inserts information taken from user-specified environment variables.

 

The syntax for this macro is %[Env:<Parameter>]

 

Note that a parameter must be used in order for this macro to return information. The following parameters are available:

 

ALLUSERSPROFILE

 

Inserts the full path to the All Users profile directory.

 

APPDATA

 

Inserts the full path to the Application Data directory of the current user.

 

CommonProgramFiles

 

Inserts the full path to the Common Files directory.

 

CommonProgramFiles(x86)

 

Inserts the full path to the (x86) Common Files directory in 64-bit versions of Windows.

 

CommonProgramFilesW6432

 

Inserts the full path to the Common Files directory in 64-bit versions of Windows.

 

COMPUTERNAME

 

Inserts the computer name.

 

HOMEDRIVE

 

Inserts the drive letter on the local computer that is connected to the user's home directory.

 

HOMEPATH

 

Inserts the complete path of the current user's Home directory, as defined by the user's account properties.

 

LOCALAPPDATA

 

Inserts the complete path to the current user's Application Data directory.

 

LOGONSERVER

 

Inserts the name of the domain controller that authenticated the client's logon request.

 

OS

 

Inserts the name of the operating system.

 

PROCESSOR_ARCHITECTURE

 

Inserts the chip architecture of the CPU.

 

ProgramData

 

Inserts the full path to the All Users profile directory.

 

ProgramFiles

 

Inserts the full path to the Program Files directory.

 

ProgramFiles(x86)

 

Inserts the full path to the (x86) Program Files directory in 64-bit versions of Windows.

 

ProgramFilesW6432

 

Inserts the full path to the Program Files directory in 64-bit versions of Windows.

 

PUBLIC

 

Inserts the full path to the Public directory.

 

SESSIONNAME

 

Inserts the session name and number when a client is connected via a terminal server.

 

SystemDrive

 

Inserts the name of the drive on which the system folder was placed.

 

SystemRoot

 

Inserts the name of the system folder.

 

TEMP

 

Inserts the name of the default temporary folder used by the operating system and applications available to the current user.

 

TMP

 

Inserts the name of the default temporary folder used by the operating system and applications available to the current user. (Note that some applications require the TEMP environment variable, whilst others require TMP. The values for both should be identical).

 

USERDOMAIN

 

Inserts the name of the user domain that contains the account of the current user.

 

USERDOMAIN_ROAMINGPROFILE

 

Inserts the name of the user domain for RDS or standard roaming profile paths.

 

USERNAME

 

Inserts the name of the current user.

 

USERPROFILE

 

Inserts the location of the current user's profile directory.

 

windir

 

Inserts the full path to the Windows directory.

 

 

Example

 

%[Env:CommonProgramFiles] inserts the full path to the Common Files directory:

 

environment.variable.example

Figure 1. [Env:CommonProgramFiles] Macro Example

 

Further information on environment variables is available here.