GetSetting (Función)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve el valor de una clave correspondiente a la entrada de una aplicación en el Registro de Windows.

La característica My proporciona mayor productividad y rendimiento en las operaciones del Registro que si se utiliza GetAllSettings. Para obtener más información, vea My.Computer.Registry (Objeto).

Public Function GetSetting( _
   ByVal AppName As String, _
   ByVal Section As String, _
   ByVal Key As String, _
   Optional ByVal Default As String = "" _
) As String

Parámetros

AppName
Requerido. Expresión de tipo String que contiene el nombre de la aplicación o proyecto cuya clave se solicita.
Section
Requerido. Expresión de tipo String que contiene el nombre de la sección donde se encuentra la clave.
Key
Requerido. Expresión de tipo String que contiene el nombre de la clave que se va a devolver.
Default
Opcional. Expresión que contiene el valor que se va a devolver si no se especifica ningún valor en Key. Si se omite, se asume que Default es una cadena de longitud cero ("").

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException	5	Uno o más argumentos no son expresiones String o el usuario no ha iniciado la sesión.

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 alguno de los elementos indicados como argumentos de GetSetting no existe, GetSetting devolverá un valor de Default.

GetSetting requiere que un usuario se conecte, ya que funciona bajo la clave de Registro HKEY_LOCAL_USER, que no se activa hasta que un usuario inicia la sesión de forma interactiva.

Los valores de configuración del Registro a los que se va a tener acceso mediante un proceso no interactivo (como Mtx.exe) deben almacenarse bajo las claves del Registro HKEY_LOCAL_MACHINE\Software\ o HKEY_USER\DEFAULT\Software.

GetSetting requiere un Permiso del Registro de tipo Read.

Ejemplo

En este ejemplo se utiliza en primer lugar la función SaveSetting para crear entradas en el Registro de Windows para la aplicación especificada como AppName y, a continuación, se usa la función GetSetting para mostrar uno de los valores. Debido a que se ha especificado el argumento Default, es seguro que se devolverá algún valor. Recuerde que los nombres de Section no se pueden recuperar con GetSetting. Por último, la función DeleteSetting quita todas las entradas de la aplicación.

' Place some settings in the registry.
SaveSetting("MyApp", "Startup", "Top", "75")
SaveSetting("MyApp", "Startup", "Left", "50")
Console.WriteLine(GetSetting("MyApp", "Startup", "Left", "25"))
DeleteSetting("MyApp")