VBScript

• CAPITULO 7: Funciones del lenguaje

CAPITULO 7: Funciones del lenguaje

En VBScript existe una librería de funciones predefinidas que el usuario puede emplear si lo considera conveniente. Al estar predefinidas no es necesario hacer nada para cargarlas en memoria. Se cargan, automáticamente, con el intérprete. Solo es necesario invocarlas donde se necesiten. Estas funciones se clasifican en grupos en base al tipo de datos con el que se emplean. Veamos cuales son y que hacen:

ABS (número)

Recibe como argumento un número (o variable que lo contiene) y devuelve el mismo número sin signo. No produce ningún efecto con números positivos y elimina el signo en los negativos.

ARRAY (Elemento1, Elemento2, ... , Elemento N)

Devuelve una matriz con los elementos que recibe, separados por comas, como argumento. Si no se le pasan argumentos, devuelve una matriz de cero elementos.

ASC (carácter)

Devuelve el valor ASCII del carácter que recibe como argumento. Si recibe una cadena, devuelve el código ASCII del primer carácter de la misma. Si recibe un dato Null, devuelve un valor Null.

ATN (número)

Recibe un número (o variable que lo contiene) que representa a un ángulo en radianes y devuelve el arco tangente de ese ángulo.

CBOOL (número)

Recibe como argumento un número (o variable que lo contiene y devuelve un valor lógico. Falso si el número es 0 y verdadero en otro caso.

CBYTE (número)

Recibe como argumento un número (o variable que lo contiene) y lo convierte a un número en formato Byte.

CCUR (número)

Recibe como argumento un número (o variable que lo contiene) y lo convierte a un número en formato Currency.

CDATE (cadena)

Recibe como argumento una cadena alfanumérica representando una fecha y la convierte en un dato se subtipo DATE.

CDBL (número)

Recibe como argumento un número (o variable que lo contiene) y lo transforma a un número en formato Double.

CHR (número)

Devuelve el carácter asociado al código ASCII pasado como argumento. El número deberá estar comprendido entre 0 y 255.

CINT (número)

Recibe como argumento un número (o variable que lo contiene) y lo transforma en un dato con formato Int.

CLNG (número)

Recibe como argumento un número (o variable que lo contiene) y lo transforma en un dato con formato Long.

COS (número)

Recibe un número (o variable que lo contiene) que representa a un ángulo en radianes y devuelve el coseno de ese ángulo.

CSNG (número)

Recibe como argumento un número (o variable que lo contiene) y lo transforma en un dato con formato Single.

CSTR (argumento)

Recibe como argumento un dato (o variable que lo contiene) que no sea una cadena alfanumérica y lo devuelve transformado en una cadena.

DATE ()

No recibe ningún argumento y devuelve la fecha del sistema.

DATEADD (intervalo, cantidad, fecha)

Esta función devuelve el resultado de sumarle un periodo de tiempo a una fecha determinada. Recibe tres parámetros obligatorios:

El intervalo es una cadena de texto que indica la unidad de tiempo que queremos añadir a la fecha (horas, días, etc). Los posibles valores están indicados a continuación.

Cadena	Significado
yyyy	año completo
q	trimestre
m	mes
d	día
w	semana
h	hora
m	minuto
s	segundo

La cantidad es el número de unidades del intervalo especificado que se le sumará a la fecha indicada. Este valor puede ser positivo, para referirse a fechas futuras o negativo para referirse a fechas pasadas.

La fecha es aquella a la que se le suman los intervalos especificados para que la función devuelva una nueva fecha como resultado de la operación.

Por ejemplo. Si tecleamos la siguiente línea de código:

	
nueva = DATEADD ("yyyy",1,10-02-1996) resultado será 10-02-1997.

Esta función tiene en cuenta incluso los años bisiestos.

DATEDIFF (intervalo, fecha 1, fecha2)

Calcula la diferencia entre las dos fechas especificadas y la devuelve expresada en los periodos indicados en intervalo. Por lo tanto devuelve un resultado numérico. Los posibles intervalos a especificar son los mismos que en el caso anterior.

DAY (fecha)

Esta función recibe como argumento una fecha y devuelve un número que corresponde al día del mes de la fecha indicada.

EXP (número)

Recibe como argumento un número (o variable que lo contiene) y devuelve el número e elevado a la potencia indicada.

FIX (número)

Recibe un número (o variable que lo contiene). Devuelve la parte entera de un número, truncando los decimales. Si el argumento es un número negativo, esta función devuelve el primer negativo igual o mayor que encuentre.

FORMATCURRENCY (número, dígitos_decimales, cero_decimal, negativos_paréntesis, agrupar_dígitos)

Esta función se usa para representar números en formato de moneda, es decir, con la apariencia de valores económicos. Recibe cuatro argumentos. El primero de ellos es el número (o variable que lo contiene) que hay que representar como cifra económica. Los otros tres son opcionales.

El parámetro dígitos_decimales especifica cuantos dígitos se quiere que aparezcan a la derecha de la coma digital.

El parámetro cero_decimal indica si se quiere completar el número con ceros a la derecha de los decimales. P.e. Si se especificaron dos decimales en el parámetro anterior y un número tiene un solo decimal ¿Queremos un cero a la derecha de ese decimal? Si lo queremos, este parámetro será un -1. Si no lo queremos, el parámetro será 0.

El parámetro negativos_paréntesis especifica si queremos que los números negativos aparezcan entre paréntesis. Si lo queremos, pondremos -1. Si no, un 0.

El parámetro agrupar_dígitos indica si queremos que los dígitos aparezcan agrupados de tres en tres, en millares, millones, etc. Si lo queremos pondremos un -1. Si no lo deseamos así, pondremos un 0.

Estos tres últimos parámetros pueden recibir como valor, en lugar de -1 o 0, un -2. En éste último caso se toman las características establecidas en la configuración regional del sistema, en el panel de control de Windows.

FORMATNUMBER (número, dígitos_decimales, cero_decimal, negativos_paréntesis, agrupar_dígitos)

Esta función opera igual que la anterior, solo que se refiere a un formato genérico, sin asociar a ninguna moneda.

HEX (número)

Recibe como argumento un número decimal (o variable que lo contiene) y lo convierte en hexadecimal.

HOUR (hora)

Esta función recibe como argumento una variable que contiene una hora en formato hh:mm:ss y devuelve la hora como un número de 0 a 23.

INSTR (comienzo, cadena 1, cadena 2)

Busca la primera aparición de la cadena 2 dentro de la cadena 1. Los parámetros comienzo y comparación son opcionales. El parámetro comienzo indica a partir de que carácter de la cadena 1 se empieza a buscar la cadena 2. Si se omite, la búsqueda se inicia desde el primer carácter.

INSTRREV (cadena 1, cadena 2, comienzo)

Esta función es similar a la anterior, solo que empieza la búsqueda por el final de la cadena.

INT (número)

Recibe un número (o variable que lo contiene). Devuelve la parte entera de un número, truncando los decimales. Si el argumento es un número negativo, esta función devuelve el primer negativo igual o menor que encuentre.

ISARRAY (variable)

Esta función recibe como argumento un nombre de una variable y comprueba si es una matriz. Devuelve un valor booleano.

ISDATE (variable)

Esta función recibe como argumento el nombre de una variable y comprueba si es una fecha. Devuelve un valor booleano.

ISEMPTY (variable)

Esta función recibe como argumento el nombre de una variable. Devuelve un valor booleano. Es verdadero si la variable no está inicializada y falso si lo está

ISNULL (variable)

Esta función recibe como argumento un nombre de variable y devuelve un valor lógico. Verdadero si la variable contiene un Null. Falso si no lo contiene.

ISNUMERIC (variable)

Recibe una variable, supuestamente numérica. Devuelve un valor lógico verdadero si el parámetro que ha recibido es una variable que contiene un número y un valor lógico falso en caso contrario.

LCASE (cadena)

Recibe como argumento una cadena (o una variable que contiene una cadena) y la convierte a minúsculas.

LEFT (cadena, longitud)

Devuelve una sub-cadena compuesta por los caracteres que hay a la izquierda de una cadena. Los argumentos que recibe son una cadena (o variable que la contiene) y la longitud (cantidad de caracteres) de la sub-cadena.

LEN (cadena)

Recibe como argumento una cadena (o variable que la contiene) y devuelve la cantidad de caracteres que componen dicha cadena.

LOG (número)

Esta función recibe como argumento un número (o una variable que lo contenga) que deberá ser mayor de 0 y devuelve el logaritmo en base e de dicho número.

LTRIM (cadena)

Recibe como argumento una cadena o variable que la contiene. Devuelve la cadena sin los espacios en blanco que hay a la izquierda de la misma.

MID (cadena, inicio, longitud)

Recibe como argumentos una cadena (o variable que la contiene), una posición de inicio (o variable numérica que la contiene) y una longitud (o variable numérica que la contiene). Devuelve una sub-cadena extraída de una cadena original. La sub cadena tiene los caracteres expresados en longitud, contados a partir del carácter inicio. Por lo tanto, el primer argumento es alfanumérico y los otros dos son numéricos.

MINUTE (hora)

Esta función recibe como argumento una variable que contiene una hora en formato hh:mm:ss y devuelve los minutos como un número de 0 a 59.

MONTH (fecha)

Esta función recibe como argumento una fecha o una variable de fecha y devuelve un número del 1 al 12 que indica el mes de la fecha.

MONTHNAME (mes, abreviado)

Esta función recibe como argumento un número del 1 al 12 (o una variable que lo contiene) y devuelve el nombre del mes correspondiente. El otro parámetro que recibe es un valor lógico para indicar si el nombre debe aparecer abreviado o no.

OCT (número)

Recibe como argumento un número decimal (o variable que lo contiene) y lo convierte en octal.

REPLACE (cadena 1, cadena 2, cambia_por, comienzo, veces)

Esta función encuentra la cadena 2 dentro de la cadena 1 y la sustituye por cambia_por. Comienza a buscar a partir del carácter cuyo número de orden es el indicado en comienzo y, si la cadena_2 aparece mas de una vez en la cadena 1 la cambia el número de veces indicado.

RIGHT (cadena, longitud)

Devuelve una sub-cadena compuesta por los caracteres que hay a la derecha de una cadena. Los argumentos que recibe son una cadena (o variable que la contiene) y la longitud (cantidad de caracteres) de la sub-cadena.

RND()

Recibe un argumento vacío y devuelve un número aleatorio. Para que funcione correctamente, es necesario incluir en el código VBScript una línea con la instrucción RANDOMIZE.

ROUND (número, decimales)

Esta función redondea el número (o variable que lo contiene) y lo devuelve con el número de decimales expresado en decimales.

RTRIM (cadena)

Recibe como argumento una cadena o variable que la contiene. Devuelve la cadena sin los espacios en blanco que hay a la derecha de la misma.

SCRIPTENGINEBUILDVERSION ()

Esta función no recibe ningún argumento y devuelve el número de versión del motor de Script que se está utilizando.

SECOND (hora)

Esta función recibe una expresión de hora en formato hh:mm:ss y devuelve el número de segundos correspondiente.

SGN (numero)

Recibe un argumento numérico y devuelve un 1 si el número es positivo, un -1 si es negativo y un 0 si es 0.

SIN (número)

Recibe un número (o variable que lo contiene) que representa a un ángulo en radianes y devuelve el seno de ese ángulo.

SPACE (numero)

Recibe como argumento un número (o variable que lo contiene) y devuelve una cadena formada por espacios en blanco; tantos como especifica el número.

SQR (número)

Devuelve la raíz cuadrada del número (o variable numérica) que recibe como argumento.

STRCOMP (cadena 1, cadena 2)

Recibe como argumentos dos cadenas alfanuméricas (o variables que las contienen) separadas por comas. Si ambas cadenas son iguales devuelve un 0. Si la primera es mayor que la segunda, devuelve un 1. Si la segunda es mayor que la primera devuelve un -1. Si alguna cadena tiene un valor Null, devuelve Null. En este sentido debemos recordar que un carácter es mayor o menor que otro en función de sus códigos ASCII. Así, p.e., la a es mayor que la A, porque el código ASCII de la A es 65 y el de la a es 97.

STRING (número, carácter)

Recibe como argumentos un número (o variable que lo contiene) y un carácter (o variable que lo contiene). Devuelve una cadena compuesta por el carácter especificado, repetido las veces que indica el número.

STRREVERSE (cadena)

Recibe como argumento una cadena (o variable que la contiene) y devuelve la cadena tras invertir el orden de todos los caracteres que la componen. Así pues, el primero de la cadena original será el último de la cadena resultante.

TAN (número)

Recibe un número (o variable que lo contiene) que representa a un ángulo en radianes y devuelve la tangente de ese ángulo.

TIME ()

Esta función no recibe ningún argumento y devuelve una expresión que representa la hora del sistema en formato hh:mm:ss.

TIMESERIAL (número 1, número 2, número 3)

Esta función recibe tres parámetros numéricos y los convierte a una hora en formato hh:mm:ss. El número 1 debe estar comprendido entre 0 y 23; el número 2 debe estar comprendido entre 0 y 59 y el número 3 también.

TIMEVALUE (fecha)

Esta función recibe una variable de fecha y extrae y devuelve la parte de la hora.

TRIM (cadena)

Recibe como argumento una cadena o variable que la contiene. Devuelve la cadena sin los espacios en blanco que hay a la izquierda y a la derecha de la misma.

TYPENAME (variable)

Esta función recibe un nombre de variable y devuelve el nombre de subtipo del dato que contiene.

UCASE (cadena)

Recibe como argumento una cadena (o una variable que contiene una cadena) y la convierte a mayúsculas.

WEEKDAY (fecha, primer_día)

Esta función recibe dos parámetros. Es primero es una fecha o variable que la contiene; el segundo es una constante que indica el que es el primer día de la semana en nuestro país. Devuelve un número correspondiente al día de la semana de la fecha introducida. Las constantes para identificar que día de la semana es el primero en nuestro país son:

Constante	Corresponde a
VBSUNDAY	Domingo
VBMONDAY	Lunes
VBTUESDAY	Martes
VBWEDNESDAY	Miércoles
VBTHURSDAY	Jueves
VBFRIDAY	Viernes
VBSATURDAY	Sábado

WEEKDAYNAME (día_semana, abreviado, primer_dia)

Esta función recibe un número de día de la semana, un valor lógico y una constante que indica cual es el primer día de la semana en nuestro país. Devuelve como resultado el nombre del día de la semana que corresponde al número introducido. Si el valor lógico es verdadero, el nombre que devuelve aparece en abreviatura. Las constantes que identifican el día de la semana son las mismas que en el caso anterior.