GetAllSettings (Función)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve una lista de claves y sus respectivos valores (originalmente creados con SaveSetting) a partir de 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 GetAllSettings( _
   ByVal AppName As String, _ 
   ByVal Section As String _
) As String(,)

Parámetros

AppName
Requerido. Expresión de tipo String que contiene el nombre de la aplicación o el proyecto cuyas claves se solicitan.
Section
Requerido. Expresión de tipo String que contiene el nombre de la sección cuyas claves se solicitan. GetAllSettings devuelve un objeto que contiene una matriz bidimensional de cadenas. Las cadenas contienen todas las claves de la sección especificada y sus valores correspondientes.

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException	5	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

GetAllSettings devuelve Object no inicializado si AppName o Section no existen.

GetAllSettings 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.

Ejemplo

En el siguiente 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 GetAllSettings para mostrar los valores. Observe que los nombres de aplicación y nombres de Section no se pueden recuperar con GetAllSettings. Por último, la función DeleteSetting quita las entradas de la aplicación.

' Object to hold 2-dimensional array returned by GetAllSettings.
' Integer to hold counter.
Dim MySettings(,) As String
Dim intSettings As Integer
' Place some settings in the registry.
SaveSetting("MyApp", "Startup", "Top", "75")
SaveSetting("MyApp", "Startup", "Left", "50")
' Retrieve the settings.
MySettings = GetAllSettings("MyApp", "Startup")
For intSettings = LBound(MySettings, 1) To UBound(MySettings, 1)
   WriteLine(1, MySettings(intSettings, 0))
   WriteLine(1, MySettings(intSettings, 1))
Next intSettings
DeleteSetting("MyApp")