Функция Environ

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает строку, связанную с переменной среды операционной системы.

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

Поделиться через