Environ (Función)

Actualización: noviembre 2007

Devuelve la cadena asociada con una variable de entorno del sistema operativo.

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

Parámetros

• Expression
  Requerido. Expresión que se evalúa como una cadena que contiene el nombre de una variable de entorno o un entero que corresponde al orden numérico de una cadena de entorno en la tabla de cadenas de entorno.

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException		No se encuentra Expression.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, se debe considerar la sustitución de dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

Si Expression contiene una cadena, la función Environ devuelve el texto asignado a la cadena de entorno especificada, es decir, el texto que sigue al signo igual (=) en la tabla de cadenas de entorno para esa variable de entorno. Si la cadena de Expression no se puede encontrar en la tabla de cadenas de entorno, se devuelve una cadena de longitud cero ("").

Si Expression contiene un entero, se devuelve la cadena que ocupa la posición numérica en la tabla de cadenas de entorno. En este caso, Environ devuelve todo el texto, incluido el nombre de la variable de entorno. Si no hay ninguna cadena de entorno en la posición especificada, Environ devuelve una cadena de longitud cero.

Nota de seguridad:
La función Environ requiere un permiso de entorno que puede afectar a su ejecución en situaciones de confianza parcial. Para obtener más información, vea SecurityPermission y Permisos de acceso a código.

Ejemplo

En este ejemplo se utiliza la función Environ para proporcionar el número de entrada y longitud de la instrucción PATH desde la tabla de cadenas de entorno.

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

Notas para desarrolladores de dispositivos inteligentes

Esta función no es compatible.

Requisitos

Espacio de nombres:Microsoft.VisualBasic

**Módulo:**Interaction

**Ensamblado:**Visual Basic Runtime Library (en Microsoft.VisualBasic.dll)

Vea también

Referencia

Miembros de la biblioteca en tiempo de ejecución de Visual Basic

ArgumentException