Interaction.Environ Method (String)
Assembly: Microsoft.VisualBasic (in microsoft.visualbasic.dll)
Required. Expression that evaluates either a string containing the name of an environment variable, or an integer corresponding to the numeric order of an environment string in the environment-string table.
Return ValueReturns the string associated with an operating-system environment variable.
For more detailed information, see the Visual Basic topic Environ Function.
If Expression contains a string, the Environ function returns the text assigned to the specified environment string—that is, the text following the equal sign (=) in the environment-string table for that environment variable. If the string in Expression cannot be found in the environment-string table, a zero-length string ("") is returned.
If Expression contains an integer, the string occupying that numeric position in the environment-string table is returned. In this case, Environ returns all of the text, including the name of the environment variable. If there is no environment string in the specified position, Environ returns a zero-length string.
This example uses the Environ function to supply the entry number and length of the PATH statement from the environment-string table.
Sub tenv() Dim envString As String Dim found As Boolean = False Dim index As Integer = 1 Dim pathLength As Integer Dim message As String envString = Environ(index) While Not found And (envString <> "") If (envString.Substring(0, 5) = "Path=") Then found = True Else index += 1 envString = Environ(index) End If End While If found Then pathLength = Environ("PATH").Length message = "PATH entry = " & index & " and length = " & pathLength Else message = "No PATH environment variable exists." End If MsgBox(message) End Sub
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.