# VSettings

Nos permite gestionar una rama de la configuración del sistema. En Windows accede al registro, en Linux se trabaja con ficheros con extensión .ini y en Mac se editan los ficheros con extensión .plist.

Para empezar hay que importar la clase con **importClass** y construir el objeto **VSettings**.

## Indice de funciones

### **Constructor**

VSettngs new [VSettings](#vsettings)( String szOrganización, String szRama )

### **Lectura y escritura del registro**

Void [setValue](#setvalue)( String szKey, Variant value )

Variant [value](#value)( String szKey, Variant value )

## Documentación de funciones

### Constructor

#### VSettings new VSettings( String szOrganización, String szRama ) <a href="#vsettings" id="vsettings"></a>

Construye una nueva clave de registro para acceder a leer y escribir claves.

Requiere importarla previamente a su uso:

importClass ( "VSettings" );

Parámetros:

* szOrganizacion: indica dentro de la rama el nombre correspondiente a la organización.
* szOrganizacion: indica dentro de la rama el nombre correspondiente a la subrama.

En Windows, la rama raíz será: HKEY\_CURRENT\_USER\Software.

En Linux, trabajará con el fichero carpeta\_de\_usuario/.config/Velneo/velneo.conf.

En Mac, trabajará con el fichero en carpeta\_de\_usuario/Library/Preferences/com.velneo.vclient.plist.

### Lectura y escritura del registro <a href="#lectura" id="lectura"></a>

#### Void setValue( String szKey, Variant value ) <a href="#setvalue" id="setvalue"></a>

Establece el valor de la clave que pasamos como parámetro.

Parámetros:

* szKey: clave cuyo valor queremos escribir.
* value: valor que se establecerá en la clave.

Equivale a los comandos de instrucción de proceso [configuración del sistema: escribir cadena de texto](https://doc.velneo.com/33/proyectos-objetos-y-editores/de-aplicacion-y-datos/proceso/sistema/configuracion#configuracion-del-sistema-eliminar-entrada) y [configuración del sistema: escribir número entero](https://doc.velneo.com/33/proyectos-objetos-y-editores/de-aplicacion-y-datos/proceso/sistema/configuracion#configuracion-del-sistema-escribir-cadena-texto).

#### Variant value( String szKey, Variant value ) <a href="#value" id="value"></a>

Devuelve el valor de la clave que pasamos como parámetro.

Parámetros:

* szKey: clave cuyo valor queremos leer.
* value: cuando la clave no existe, se devolverá este valor en vez de una cadena vacía.

Equivale a los comandos de instrucción de proceso [configuración del sistema: leer cadena de texto](https://doc.velneo.com/33/proyectos-objetos-y-editores/de-aplicacion-y-datos/proceso/sistema/configuracion#configuracion-del-sistema-escribir-numero-entero) y [configuración del sistema: leer número entero](https://doc.velneo.com/33/proyectos-objetos-y-editores/de-aplicacion-y-datos/proceso/sistema/configuracion#configuracion-del-sistema-leer-numero-entero).

## Ejemplo

### Crear una entrada en la carpeta Velneo/vClient en el registro del sistema operativo

```javascript
importClass ( "VSettings" );
var clave = new VSettings( "Velneo", "vClient" );
clave.setValue("proKey", "xw002pd24f007yZ23");
```