Todo Funciones Grupos Páginas
files

Funciones

BOOLEAN files.exists (STRING path)
 Permite saber si existe un archivo o una carpeta. Más...
 
STRING files.cdir ()
 Permite saber la ruta de trabajo actual. Más...
 
NIL files.cdir (STRING path)
 Cambia la Ruta de trabajo actual a la ruta especificada. Más...
 
STRING files.nofile (STRING path)
 Retira el archivo de una ruta especifica. Más...
 
STRING files.nopath (STRING path)
 Retira la carpeta de una ruta especifica. Más...
 
NUMBER files.rename (STRING name, STRING new)
 Permite renombrar un archivo o carpeta. Más...
 
NUMBER files.copy (STRING src, STRING dst)
 Copia un archivo o carpeta en forma recursiva y sobreescribe los archivos en la carpeta destino. Más...
 
NUMBER files.move (STRING src, STRING dst)
 Mueve un archivo o carpeta en forma recursiva y sobreescribe los archivos en la carpeta destino. Más...
 
BOOLEAN files.delete (STRING path)
 Elimina un archivo o carpeta en forma recursiva. Más...
 
NIL files.mkdir (STRING path)
 Permite crear una carpeta. Más...
 
NUMBER files.size (STRING path)
 Tamaño de un archivo/carpeta (Bytes). Más...
 
STRING files.ext (STRING path)
 Permite conocer la extensión de un archivo. Más...
 
TABLE files.list (STRING path)
 Lista un directorio incluyendo carpetas y archivos. Más...
 
TABLE files.listfiles (STRING path)
 Lista un directorio incluyendo solamente archivos. Más...
 
TABLE files.listdirs (STRING path)
 Lista un directorio incluyendo solamente carpetas. Más...
 
TABLE files.scan (STRING src)
 Obtiene una lista del contenido de un archivo comprimido (.zip y .rar). Más...
 
NUMBER files.extractfile (STRING src, STRING filename, STRING dst)
 Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar). Más...
 
NUMBER files.extractfile (STRING src, STRING filename, STRING dst, STRING pass)
 Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar). Más...
 
NUMBER files.threadextractfile (STRING src, STRING filename, STRING dst)
 Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar) en modo HILO. Más...
 
NUMBER files.threadextractfile (STRING src, STRING filename, STRING dst, STRING pass)
 Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar) en modo HILO. Más...
 
NUMBER files.extract (STRING src, STRING dst)
 Función para extraer archivos en formato .zip y .rar. Más...
 
NUMBER files.extract (STRING src, STRING dst, STRING pass)
 Función para extraer archivos en formato .zip y .rar. Más...
 
NUMBER files.threadextract (STRING src, STRING dst)
 Función para extraer archivos en formato .zip y .rar en modo HILO. Más...
 
NUMBER files.threadextract (STRING src, STRING dst, STRING pass)
 Función para extraer archivos en formato .zip y .rar en modo HILO. Más...
 

Descripción detallada

Manejo del sistema de archivos.

Documentación de las funciones

BOOLEAN files.exists ( STRING  path)

Permite saber si existe un archivo o una carpeta.

Parámetros
pathRuta del archivo o carpeta.
Devuelve
true/false Según si el archivo/carpeta existe.
STRING files.cdir ( )

Permite saber la ruta de trabajo actual.

Devuelve
La ruta de nuestro directorio actual.
NIL files.cdir ( STRING  path)

Cambia la Ruta de trabajo actual a la ruta especificada.

Parámetros
pathEs la ruta de la nueva carpeta de trabajo.
Devuelve
Nada.
STRING files.nofile ( STRING  path)

Retira el archivo de una ruta especifica.

Parámetros
pathEs la ruta del archivo/carpeta.
Devuelve
El nombre de la ruta sin el archivo.
STRING files.nopath ( STRING  path)

Retira la carpeta de una ruta especifica.

Parámetros
pathEs la ruta del archivo/carpeta.
Devuelve
El nombre del archivo.
NUMBER files.rename ( STRING  name,
STRING  new 
)

Permite renombrar un archivo o carpeta.

Parámetros
nameEs la ruta del archivo/carpeta.
newEs el nuevo nombre del archivo/carpeta.
Devuelve
Un número con valor de 1 en caso de éxito o 0 en caso de error.
NUMBER files.copy ( STRING  src,
STRING  dst 
)

Copia un archivo o carpeta en forma recursiva y sobreescribe los archivos en la carpeta destino.

Parámetros
srcLa ruta del archivo/carpeta a copiar.
dstLa ruta a la carpeta destino.
Nota
Esta función permite utilizar el callback onCopyFiles(), más información aquí .
Devuelve
Un número con valor de 1 en caso de éxito o 0 en caso de error.
NUMBER files.move ( STRING  src,
STRING  dst 
)

Mueve un archivo o carpeta en forma recursiva y sobreescribe los archivos en la carpeta destino.

Parámetros
srcLa ruta del archivo/carpeta a mover.
dstLa ruta a la carpeta destino.
Nota
Sí el archivo o ruta destino no existe, el directorio será creado.
Devuelve
Un número con valor de 1 en caso de éxito o 0 en caso de error.
BOOLEAN files.delete ( STRING  path)

Elimina un archivo o carpeta en forma recursiva.

Parámetros
pathEs la ruta del archivo/carpeta.
Devuelve
true/false Según si el archivo/carpeta se elimino correctamente.
Nota
Se eliminarán todas las carpetas y archivos incluidos.
NIL files.mkdir ( STRING  path)

Permite crear una carpeta.

Parámetros
pathEs la ruta de la carpeta a crear.
Devuelve
Nada.
NUMBER files.size ( STRING  path)

Tamaño de un archivo/carpeta (Bytes).

Parámetros
pathEs la ruta del archivo/carpeta.
Devuelve
El tamaño del archivo/carpeta en bytes.
STRING files.ext ( STRING  path)

Permite conocer la extensión de un archivo.

Parámetros
pathEs la ruta del archivo.
Devuelve
La extensión del archivo.
TABLE files.list ( STRING  path)

Lista un directorio incluyendo carpetas y archivos.

Parámetros
pathEs la ruta del directorio a listar.
Devuelve
Una tabla con los siguientes campos:
  • name: Es el nombre del archivo o carpeta (STRING).
  • path: Ruta completa del archivo o carpeta (STRING).
  • ctime: La fecha de creación del archivo o carpeta (STRING).
  • atime: La fecha del último acceso del archivo o carpeta (STRING).
  • mtime: La fecha de la última modificación del archivo o carpeta (STRING).
  • mode: Son los derechos de acceso en el siguiente orden: "R": Lectura, "W": Escritura y "X" Ejecutable. En caso de no contar con algún permiso será mostrado de la siguiente forma: "---".
  • size: Tamaño en bytes, no aplica para carpetas (NUMBER).
  • directory: true/false según si el campo es un directorio o no (BOOLEAN).
  • ext: La extensión del archivo, en caso de tenerla.
Nota
En caso de error no generará la tabla, devolverá nil.
TABLE files.listfiles ( STRING  path)

Lista un directorio incluyendo solamente archivos.

Parámetros
pathEs la ruta del directorio a listar.
Devuelve
Una tabla con los siguientes campos:
  • name: Es el nombre del archivo o carpeta (STRING).
  • path: Ruta completa del archivo o carpeta (STRING).
  • ctime: La fecha de creación del archivo o carpeta (STRING).
  • atime: La fecha del último acceso del archivo o carpeta (STRING).
  • mtime: La fecha de la última modificación del archivo o carpeta (STRING).
  • mode: Son los derechos de acceso en el siguiente orden: "R": Lectura, "W": Escritura y "X" Ejecutable. En caso de no contar con algún permiso será mostrado de la siguiente forma: "---".
  • size: Tamaño en bytes (NUMBER).
  • ext: La extensión del archivo, en caso de tenerla.
Nota
En caso de error no generará la tabla, devolverá nil.
TABLE files.listdirs ( STRING  path)

Lista un directorio incluyendo solamente carpetas.

Parámetros
pathEs la ruta del directorio a listar.
Devuelve
Una tabla con los siguientes campos:
  • name: Es el nombre del archivo o carpeta (STRING).
  • path: Ruta completa del archivo o carpeta (STRING).
  • ctime: La fecha de creación del archivo o carpeta (STRING).
  • atime: La fecha del último acceso del archivo o carpeta (STRING).
  • mtime: La fecha de la última modificación del archivo o carpeta (STRING).
  • mode: Son los derechos de acceso en el siguiente orden: "R": Lectura, "W": Escritura y "X" Ejecutable. En caso de no contar con algún permiso será mostrado de la siguiente forma: "---".
Nota
En caso de error no generará la tabla, devolverá nil.
TABLE files.scan ( STRING  src)

Obtiene una lista del contenido de un archivo comprimido (.zip y .rar).

Parámetros
srcEs la ruta del archivo a escanear.
Devuelve
Una tabla con los siguientes campos:
  • name: Es el nombre del archivo, puede incluir en el nombre: carpeta/archivo (STRING).
  • size: Tamaño real en bytes del archivo sin compresión (NUMBER).
Nota
En caso de error no generará la tabla, devolverá nil.
NUMBER files.extractfile ( STRING  src,
STRING  filename,
STRING  dst 
)

Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar).

Parámetros
srcEs la ruta del archivo a extraer.
filenameEs el nombre del archivo a extraer (se puede obtener fácilmente desde la tabla que devuelve files.scan()).
dstEs la ruta donde se van guardar los archivos a extraer.
Nota
  • Esta función permite utilizar el callback onExtractFiles(), más información aquí .
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolverá un valor numérico de 1, en caso de error devolverá 0.
NUMBER files.extractfile ( STRING  src,
STRING  filename,
STRING  dst,
STRING  pass 
)

Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar).

Parámetros
srcEs la ruta del archivo a extraer.
filenameEs el nombre del archivo a extraer (se puede obtener fácilmente desde la tabla que devuelve files.scan()).
dstEs la ruta donde se van guardar los archivos a extraer.
passEs la clave o contraseña en caso de ser requerida.
Nota
  • Esta función permite utilizar el callback onExtractFiles(), más información aquí .
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolverá un valor numérico de 1, en caso de error devolverá 0.
NUMBER files.threadextractfile ( STRING  src,
STRING  filename,
STRING  dst 
)

Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar) en modo HILO.

Parámetros
srcEs la ruta del archivo a extraer.
filenameEs el nombre del archivo a extraer (se puede obtener fácilmente desde la tabla que devuelve files.scan()).
dstEs la ruta donde se van guardar los archivos a extraer. Esta es una lista de todas las constantes disponibles y su posibles valores:
  • __FILES_THREAD_FILE
    • Permite conocer el nombre del archivo actual que se esta extrayendo.
  • __FILES_THREAD_STATE
    • Permite conocer el estado de la Extracción.
    • 0: No hay Extracción o esta iniciando.
    • 1: Extracción terminada con exito.
    • 2: Extracción en progreso.
    • -1: Ocurrio un error en la Extracción.
  • __FILES_THREAD_SIZE
    • Permite cononer el número de bytes a extraer del archivo actual.
  • __FILES_THREAD_WRITTEN
    • Permite conocer el número de bytes escritos del archivo actual.
Nota
  • Esta función permite continuar con el script, de tal manera que se ejecuta de manera secundaria, para mayor uso, refierase a los ejemplos Ejemplos de uso de OneLua.
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolver un valor numérico de 1, en caso de error devolverá 0.
NUMBER files.threadextractfile ( STRING  src,
STRING  filename,
STRING  dst,
STRING  pass 
)

Función para extraer un archivo en específico dentro de un comprimido (.zip y .rar) en modo HILO.

Parámetros
srcEs la ruta del archivo a extraer.
filenameEs el nombre del archivo a extraer (se puede obtener fácilmente desde la tabla que devuelve files.scan()).
dstEs la ruta donde se van guardar los archivos a extraer.
passEs la clave o contraseña en caso de ser requerida. Esta es una lista de todas las constantes disponibles y su posibles valores:
  • __FILES_THREAD_FILE
    • Permite conocer el nombre del archivo actual que se esta extrayendo.
  • __FILES_THREAD_STATE
    • Permite conocer el estado de la Extracción.
    • 0: No hay Extracción o esta iniciando.
    • 1: Extracción terminada con exito.
    • 2: Extracción en progreso.
    • -1: Ocurrio un error en la Extracción.
  • __FILES_THREAD_SIZE
    • Permite cononer el número de bytes a extraer del archivo actual.
  • __FILES_THREAD_WRITTEN
    • Permite conocer el número de bytes escritos del archivo actual.
Nota
  • Esta función permite continuar con el script, de tal manera que se ejecuta de manera secundaria, para mayor uso, refierase a los ejemplos Ejemplos de uso de OneLua.
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolver un valor numérico de 1, en caso de error devolverá 0.
NUMBER files.extract ( STRING  src,
STRING  dst 
)

Función para extraer archivos en formato .zip y .rar.

Parámetros
srcEs la ruta del archivo a extraer.
dstEs la ruta donde se van guardar los archivos a extraer.
Nota
  • Esta función permite utilizar el callback onExtractFiles(), más información aquí .
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolver un valor numérico de 1, en caso de error devolverá 0.
NUMBER files.extract ( STRING  src,
STRING  dst,
STRING  pass 
)

Función para extraer archivos en formato .zip y .rar.

Parámetros
srcEs la ruta del archivo a extraer.
dstEs la ruta donde se van guardar los archivos a extraer.
passEs la clave o contraseña en caso de ser requerida.
Nota
  • Esta función permite utilizar el callback onExtractFiles(), más información aquí .
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolver un valor numérico de 1, en caso de error devolverá 0.
NUMBER files.threadextract ( STRING  src,
STRING  dst 
)

Función para extraer archivos en formato .zip y .rar en modo HILO.

Parámetros
srcEs la ruta del archivo a extraer.
dstEs la ruta donde se van guardar los archivos a extraer. Esta es una lista de todas las constantes disponibles y su posibles valores:
  • __FILES_THREAD_FILE
    • Permite conocer el nombre del archivo actual que se esta extrayendo.
  • __FILES_THREAD_STATE
    • Permite conocer el estado de la Extracción.
    • 0: No hay Extracción o esta iniciando.
    • 1: Extracción terminada con exito.
    • 2: Extracción en progreso.
    • -1: Ocurrio un error en la Extracción.
  • __FILES_THREAD_SIZE
    • Permite cononer el número de bytes a extraer del archivo actual.
  • __FILES_THREAD_WRITTEN
    • Permite conocer el número de bytes escritos del archivo actual.
Nota
  • Esta función permite continuar con el script, de tal manera que se ejecuta de manera secundaria, para mayor uso, refierase a los ejemplos Ejemplos de uso de OneLua.
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolver un valor numérico de 1, en caso de error devolverá 0.
NUMBER files.threadextract ( STRING  src,
STRING  dst,
STRING  pass 
)

Función para extraer archivos en formato .zip y .rar en modo HILO.

Parámetros
srcEs la ruta del archivo a extraer.
dstEs la ruta donde se van guardar los archivos a extraer.
passEs la clave o contraseña en caso de ser requerida. Esta es una lista de todas las constantes disponibles y su posibles valores:
  • __FILES_THREAD_FILE
    • Permite conocer el nombre del archivo actual que se esta extrayendo.
  • __FILES_THREAD_STATE
    • Permite conocer el estado de la Extracción.
    • 0: No hay Extracción o esta iniciando.
    • 1: Extracción terminada con exito.
    • 2: Extracción en progreso.
    • -1: Ocurrio un error en la Extracción.
  • __FILES_THREAD_SIZE
    • Permite cononer el número de bytes a extraer del archivo actual.
  • __FILES_THREAD_WRITTEN
    • Permite conocer el número de bytes escritos del archivo actual.
Nota
  • Esta función permite continuar con el script, de tal manera que se ejecuta de manera secundaria, para mayor uso, refierase a los ejemplos Ejemplos de uso de OneLua.
  • Sí la ruta destino no existe, automáticamente será creada.
Devuelve
En caso de éxito devolver un valor numérico de 1, en caso de error devolverá 0.