Files
harbour-core/harbour/doc/es/dir.txt
2003-07-13 14:51:56 +00:00

244 lines
9.3 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/*
* $Id$
*/
/*
* Las siguientes partes son derechos adquiridos de sus autores individuales.
* www - http://www.harbour-project.org
*
* Copyright 2000 Alejandro de G rate <alex_degarate@hotmail.com>
* Documentaci¢n en Espa¤ol de: __DIR(), DIR, ADIR()
*
* Copyright 1999 Chen Kedem <niki@actcom.co.il>
* Documentaci¢n en Ingls de: __DIR(), DIR, ADIR()
*
* Vea doc/license.txt por los trminos de la licencia.
*
*/
/* $DOC$
* $FUNCNAME$
* __Dir()*
* $CATEGORY$
* Manejo de Archivos
* $ONELINER$
* Muestra por pantalla el listado de archivos.
* $SYNTAX$
* __Dir( [<cFileMask>] ) --> NIL
* $ARGUMENTS$
* <cFileMask> M scara de archivos para incluir en el retorno de la
* funci¢n. Esta podr¡a contener subdirectorios (path) y caracteres
* est ndar usados como comodines, segun sean soportados por el sistema
* operativo (como * y ?). Si <cFileMask> no contiene la ruta al archivo
* entonces SET DEFAULT es usado para mostrar archivos en la m scara.
* $RETURNS$
* __Dir() siempre retorna NIL.
* $DESCRIPTION$
* Si ninguna <cFileMask> es dada, __Dir() muestra informaci¢n acerca de
* todos los *.DBF en la ruta SET DEFAULT. Esta informaci¢n contiene:
* - Nombre del archivo
* - Numero de registros
* - Fecha de la ultima actualizaci¢n
* - Tama¤o de cada archivo.
*
* Si <cFileMask> es dada, __Dir() lista todos los archivos que
* coinciden con la m scara en los siguientes detalles: Nombre,
* Extensi¢n, Tama¤o, Fecha.
*
* El comando DIR es pre-procesado en la funci¢n __Dir() durante el
* tiempo de compilaci¢n.
*
* __Dir() es una funci¢n de compatibilidad, esta fu superada por
* DIRECTORY(), la cual devuelve toda la informaci¢n en un arreglo
* multidimensional.
* $EXAMPLES$
* <fixed>
* __Dir() // Informaci¢n de todos los DBF en el directorio actual
*
* __Dir( "*.dbf" ) // Lista todos los DBF en el directorio actual
*
* // Lista todos los PRG de la librer¡a de ejecuci¢n (RTL) de Harbour
* // para sistemas operativos compatibles con DOS
* __Dir( "c:\harbour\source\rtl\*.prg" )
*
* // Lista todos los archivos de la secci¢n p£blica sobre una m quina
* // tipo Unix
* __Dir( "/pub" )
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* Informaci¢n de DBF: CA-Clipper muestra nombres de archivos en el
* formato 8.3, Harbour muestra los primeros 15 caracteres si un nombre
* largo de archivo esta disponible.
*
* Listado de archivos: para formatear los nombres mostrados usamos algo
* as¡ como:
* PADR( Nombre, 8 ) + " " + PADR( Ext, 3 )
* CA-Clipper usa nombres de archivo 8.3, con Harbour probablemente se
* podr¡a cortar los nombres largos de archivo para llenar este molde.
* $FILES$
* La librer¡a es rtl
* $SEEALSO$
* ADIR()*,DIRECTORY(),SET DEFAULT,DIR
* $END$
*/
/* $DOC$
* $FUNCNAME$
* DIR
* $CATEGORY$
* Comando
* $ONELINER$
* Muestra el listado de archivos
* $SYNTAX$
* DIR [<cFileMask>]
* $ARGUMENTS$
* <cFileMask> M scara de archivos para incluir en el retorno de la
* funci¢n. Esta podr¡a contener subdirectorios (path) y caracteres
* est ndar usados como comdines, segun sean soportados por el sistema
* operativo (como * y ?). Si <cFileMask> no contiene la ruta al archivo
* entonces SET DEFAULT es usado para mostrar archivos en la m scara.
* $DESCRIPTION$
* Si ninguna <cFileMask> es dada, __Dir() muestra informaci¢n acerca de
* todos los *.DBF en la ruta SET DEFAULT. esta informaci¢n contiene:
* - Nombre del archivo
* - N£mero de registros
* - Fecha de la ultima actualizaci¢n
* - Tama¤o de cada archivo.
*
* Si <cFileMask> es dada,__Dir() lista todos los archivos que coinciden
* con la m scara en los siguientes detalles: Nombre, Extensi¢n, Tama¤o,
* Fecha.
*
* El comando DIR es pre-procesado en la funci¢n __Dir() durante el
* tiempo de compilaci¢n.
*
* __Dir() es una funci¢n de compatibilidad, esta fu superada por
* DIRECTORY(), la cual devuelve toda la informaci¢n en un arreglo
* multidimensional.
* $EXAMPLES$
* <fixed>
* __Dir() // Informaci¢n de todos los DBF en el directorio actual
*
* __Dir( "*.dbf" ) // Lista todos los DBF en el directorio actual
*
* // Lista todos los PRG de la librer¡a de ejecuci¢n (RTL) de Harbour
* // para sistemas operativos compatibles con DOS
* __Dir( "c:\harbour\source\rtl\*.prg" )
*
* // Lista todos los archivos de la secci¢n p£blica sobre una m quina
* // tipo Unix
* __Dir( "/pub" )
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* Informaci¢n de DBF: CA-Clipper muestra nombres de archivos en el
* formato 8.3, Harbour muestra los primeros 15 caracteres si un nombre
* largo de archivo est  disponible.
*
* Listado de archivos: para formatear los nombres mostrados usamos algo
* as¡ como:
* PADR( Nombre, 8 ) + " " + PADR( Ext, 3 )
* CA-Clipper usa nombres de archivo 8.3, con Harbour probablemente se
* podr¡a cortar los nombres largos de archivo para llenar este molde.
* $SEEALSO$
* ADIR()*,DIRECTORY(),SET DEFAULT,__DIR()*
* $END$
*/
/* $DOC$
* $FUNCNAME$
* ADIR()*
* $CATEGORY$
* ARRAY
* $ONELINER$
* Llena arrays pre-definidos con informaci¢n de archivo / directorio
* $SYNTAX$
* ADIR( [<cFileMask>], [<aNombre>], [<aTamano>], [<aFecha>],
* [<aHora>], [<aAtrib>] ) -> nEntradasDirectorio
* $ARGUMENTS$
* <cFileMask> M scara de archivos para incluir en el retorno de la
* funci¢n. Esta podria contener subdirectorios (path) y caracteres
* estandar usados como comodines, segun sean soportados por el sistema
* operativo (como * y ?). Si <cFileMask> no contiene la ruta al archivo
* entonces SET DEFAULT es usado para mostrar archivos en la m scara.
*
* <aNombre> Array para llenar con el Nombre de los archivos que cumplen
* con <cFileMask>. Cada elemento es una cadena de caracteres que
* incluye el Nombre y Extensi¢n del archivo sin la ruta de acceso.
* Nombre es el nombre largo de archivo como es reportado por el sistema
* operativo y no necesariamente en el formato may£sculas 8.3 del D.O.S.
*
* <aTamano> Array para llenar con el Tama¤o de los archivos que
* cumplen con <cFileMask>. Cada elemento es un n£mero entero con el
* tama¤o del archivo en bytes.
* Los Directorios siempre tienen un tama¤o cero.
*
* <aFecha> Array para llenar con la Fecha de la ultima modificaci¢n del
* archivo que cumplen con <cFileMask>. Cada elemento es del tipo "Date"
*
* <aHora> Array para llenar con la Hora de la ultima modificaci¢n del
* archivo que cumplen con <cFileMask>. Cada elemento es una cadena de
* caracteres en el formato: HH:MM:SS.
*
* <aAtrib> Array para llenar con los atributos de los archivos que
* cumplen con <cFileMask>. Cada elemento es una cadena de caracteres,
* Vea DIRECTORY() por informaci¢n sobre los valores de los atributos.
* Si Ud. pasa un array a <aAtrib>, la funci¢n va a devolver archivos
* con los atributos Normal, Oculto (H), sistema (S) y directorio (D)
* Si <aAtrib> no es especificado o es distinto de un array solo
* archivos con atributo normal porian ser devueltos.
*
* Nota: Al momento de escribir esta documentaci¢n todavia no hab¡a
* informaci¢n sobre el comportamiento de esta funci¢n con los
* atributos que poseen las maquinas tipo Unix.
* $RETURNS$
* ADIR() retorna el n£mero de entradas de archivo que cumplen con la
* condici¢n establecida en la m scara <cFileMask>.
* $DESCRIPTION$
* ADIR() retorna el n£mero de archivos y/o directorios que cumplen con
* un formato especificado, este tambien llena una serie de arrays con
* Nombre, Tama¤o, Fecha, Hora y Atributo de estos archivos.
* El array pasado debe ser pre-inicializado al tama¤o apropiado, vea el
* ejemplo m s abajo.
* Con motivo de incluir los atributos Oculto (H), sistema (S) o de
* directorio (D) <aAtrib> debe ser especificado.
*
* ADIR() es una funci¢n de compatibilidad, esta fue superada por
* DIRECTORY(), la cual devuelve toda la informaci¢n en un arreglo
* multidimensional.
* $EXAMPLES$
* <fixed>
* LOCAL aNombre, aTamano, aFecha, aHora, aAtrib, nLen, i
* nLen := ADIR( "*.JPG" ) // Nro de archivos JPG files en directorio
*
* IF nLen > 0
* aNombre := Array( nLen ) // hace lugar para guardar la informac.
* aTamano := Array( nLen )
* aFecha := Array( nLen )
* aHora := Array( nLen )
* aAtrib := Array( nLen )
*
* FOR i = 1 TO nLen
* ? aNombre[i], aTamano[i], aFecha[i], aHora[i], aAtrib[i]
* NEXT
* ELSE
* ? "Este directorio no tiene ni pelusa"
* ENDIF
* </fixed>
* $STATUS$
* R
* $COMPLIANCE$
* <aNombre> esta yendo a ser llenado con nombres largos de archivo y
* no necesariamente con el formato may£sculas 8.3 del D.O.S.
* $FILES$
* La librer¡a es rtl
* $SEEALSO$
* ARRAY(),DIRECTORY(),SET DEFAULT
* $END$
*/