Environ 函数

  • 项目

更新：2007 年 11 月

返回与操作系统环境变量关联的字符串。

Overloads Function Environ(ByVal Expression As Integer) As String
' -or-
Overloads Function Environ(ByVal Expression As String) As String

参数

  • Expression
    必选。表达式，计算为包含环境变量名称的字符串，或对应于环境字符串表中环境字符串的数字顺序的整数。

异常

异常类型

错误号

条件

ArgumentException

5

缺少 Expression。

如果正在升级使用无结构错误处理的 Visual Basic 6.0 应用程序，请参见“错误号”一列。（您可以根据 Number 属性（Err 对象）比较错误号。）然而，如果可能，应当考虑用 Visual Basic 的结构化异常处理概述替换这种错误控制。

备注

如果 Expression 包含字符串，则 Environ 函数返回分配给指定环境字符串的文本；即位于等号 (=) 后的、与该环境变量对应的环境字符串表中的文本。如果在环境字符串表中无法找到 Expression 中的字符串，则返回零长度字符串 ("")。

如果 Expression 包含整数，则返回占据环境字符串表中该数字位置的字符串。在这种情况下，则 Environ 返回所有文本，包含环境变量名称。如果指定的位置没有环境字符串，则 Environ 返回零长度字符串。

安全说明：

Environ 函数需要环境权限，这可能会对它在部分信任情况下的执行产生影响。有关更多信息，请参见 SecurityPermission 和代码访问权限。

示例

此示例使用 Environ 函数提供环境字符串表中的 PATH 语句的项编号和长度。

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

智能设备开发人员说明

不支持此函数。

要求

命名空间：Microsoft.VisualBasic

**模块：**Interaction

**程序集：**Visual Basic 运行库（在 Microsoft.VisualBasic.dll 中）

请参见

参考

Visual Basic 运行时库成员

ArgumentException