4D v16.3

TEXT TO DOCUMENT

Inicio

 
4D v16.3
TEXT TO DOCUMENT

TEXT TO DOCUMENT 


 

TEXT TO DOCUMENT ( nomArchivo ; texto {; conjCaract {; ModoRetorno}} )  
Parámetro Tipo   Descripción
nomArchivo  Cadena in Nombre del documento o ruta de acceso al documento
texto  Texto in Texto a almacenar en el documento
conjCaract  Texto, Entero largo in Nombre o número del conjunto de caracteres
ModoRetorno  Entero largo in Modo de procesamiento para los retornos de línea

El comando TEXT TO DOCUMENT le permite escribir el texto directamente en el archivo de disco.

En nomArchivo, pase el nombre o ruta de acceso del archivo a escribir. Si el archivo no existe, se crea. Cuando el archivo ya existe en el disco, su contenido anterior se borrará, excepto si ya está abierto, en cuyo caso, su contenido se bloquea y se genera un error. En nomArchivo, que puede pasar:

  • sólo el nombre del archivo, por ejemplo "miArchivo.txt": en este caso, el archivo se coloca junto al archivo de estructura de la aplicación.
  • una ruta de acceso relativa al archivo de estructura de la aplicación, por ejemplo, "\\docs\\miArchivo.txt" en Windows o ":docs:miArchivo.txt" en OS X.
  • una ruta de acceso absoluta, por ejemplo, "c:\\app\\docs\\miArchivo.txt" en Windows o "MacHD:docs:miArchivo.txt" en OS X.

Si desea que el usuario sea capaz de indicar el nombre o la ubicación del documento, utilice los comandos Open document o Create document , así como la variable del sistema Document.

Nota: por defecto, los documentos generados por este comando no tienen una extensión. Debe pasar una extensión en nomArchivo. También puede utilizar el comando SET DOCUMENT TYPE.

En texto, pase el texto a escribir en el disco. Puede ser una constante literal ("mi texto"), o un campo o variable texto 4D.

En conjCaract, pase el conjunto de caracteres a utilizar para la escritura del documento. Puede pasar una cadena con el nombre estándar del conjunto (por ejemplo, "ISO-8859-1" o "UTF-8") o su ID MIBEnum (entero largo). Para más información sobre la lista de conjuntos de caracteres soportados por 4D, consulte la descripción del comando CONVERT FROM TEXT. Si un Byte Order Mark (BOM) existe para el conjunto de caracteres, 4D lo inserta en el documento. Si no se especifica un conjunto de caracteres, 4D utiliza por defecto el conjunto de caracteres "UTF_8 " y un BOM.

En modoRetorno, puede pasar un entero largo que indica el proceso a aplicar a los caracteres de fin de línea antes de guardarlos en el archivo. Puede pasar una de las siguientes constantes, ubicadas en el tema "Documentos sistema":

Constante Tipo Valor Comentario
Document unchanged Entero largo 0 Ningún proceso
Document with CR Entero largo 3 Las líneas de ruptura se convierten al formato OS X: CR (retorno de carro)
Document with CRLF Entero largo 2 Las líneas de ruptura se convierten al formato Windows: CRLF (retorno de carro + salto de línea)
Document with LF Entero largo 4 Las líneas de ruptura se convierten al formato Unix: LF (salto de línea)
Document with native format Entero largo 1 (Por defecto) las líneas de ruptura se convierten al formato nativo del sistema operativo: CR (retorno de carro) en OS X, CRLF (retorno de carro + salto de línea) en Windows

Por defecto, si omite el parámetro modoRetorno, los caracteres de fin de línea se procesan en modo nativo (1).

Nota: este comando no modifica la variable OK. En caso de falla, se genera un error que puede interceptar utilizando un método instalado por el comando ON ERR CALL.

Estos son algunos ejemplos típicos de uso de este comando:

 TEXT TO DOCUMENT("myTest.txt";"Esta es una prueba")
 TEXT TO DOCUMENT("myTest.xml";"Esta es una prueba")

Ejemplo que permite al usuario indicar la ubicación del archivo a crear:

 $MyTextVar:="Esta es una prueba"
 ON ERR CALL("IO ERROR HANDLER")
 $vhDocRef :=Create document("")
  // Guardar documento con la extensión ".txt"
  // En este caso, la extensión .txt siempre se añade al nombre; no es posible cambiarla
 If(OK=1) // Si el documento se ha creado con éxito
    CLOSE DOCUMENT($vhDocRef//Cerrar el documento
    TEXT TO DOCUMENT(Document;$MyTextVar )
  // Escribimos el documento
 Else
  // Gestión de error
 End if



Ver también 

Document to text
Documentos sistema

 
PROPIEDADES 

Producto: 4D
Tema: Documentos del sistema
Número 1237

This command can be run in preemptive processes

 
HISTORIA 

Creado por: 4D v14

 
ARTICLE USAGE

Manual de lenguaje 4D ( 4D v16)
Manual de lenguaje 4D ( 4D v16.1)
Manual de lenguaje 4D ( 4D v16.2)
Manual de lenguaje 4D ( 4D v16.3)