fopen, _wfopen

Artículo
06/09/2015

Abre un archivo. Hay disponibles versiones más seguras de estas funciones. Vea fopen_s, _wfopen_s.

FILE *fopen(     const char *filename,    const char *mode  ); FILE *_wfopen(     const wchar_t *filename,    const wchar_t *mode  );

Parámetros

filename
Nombre de archivo.
mode
Tipo de acceso habilitado.

Valor devuelto

Cada una de estas funciones devuelve un puntero al archivo abierto. Un valor de puntero null indica un error. Si filename o mode es NULL o una cadena vacía, estas funciones inician el controlador de parámetro no válido, descrito en Validación de parámetros. Si la ejecución puede continuar, estas funciones devuelven NULL y establecen errno en EINVAL.

Para obtener más información, vea errno, _doserrno, _sys_errlist y _sys_nerr.

Comentarios

La función fopen abre el archivo especificado por filename. _wfopen es una versión con caracteres anchos de fopen; los argumentos a _wfopen son cadenas de caracteres anchos. De lo contrario, los objetos _wfopen y fopen se comportan de forma idéntica. Usar solo _wfopen no tiene ningún efecto en el juego de caracteres codificados que se utiliza en la secuencia de archivo.

fopen acepta las rutas válidas en el sistema de archivos en el momento de la ejecución; fopen acepta las rutas UNC y las rutas que requieren unidades de red asignadas siempre y cuando el sistema que ejecuta el código tenga acceso al recurso compartido o a la unidad asignada en el momento de la ejecución. Al construir rutas para fopen, asegúrese de que las unidades, rutas de acceso o recursos compartidos de red están disponibles en el entorno de ejecución. Puede usar las barras diagonales (/) o barras diagonales inversas (\) como separadores de directorio en una ruta.

Compruebe siempre el valor devuelto para ver si el puntero es NULL antes de realizar cualquier operación posterior en el archivo. Si se produce un error, la variable global errno se establece y se puede usar para obtener información específica del error. Para obtener más información, vea errno, _doserrno, _sys_errlist y _sys_nerr.

Compatibilidad con Unicode

fopen admite secuencias de archivo Unicode. Para abrir un archivo Unicode, pase un indicador de ccs que especifica la codificación deseada a fopen, como sigue:

fopen(&fp, "newfile.txt", "rt+, ccs=encoding");

Los valores permitidos de encoding son UNICODE, UTF-8 y UTF-16LE.

Cuando un archivo se abre en modo Unicode, las funciones de entrada traducen los datos leídos de dicho archivo a datos UTF-16 almacenados como de tipo wchar_t. Las funciones que escriben en un archivo abierto en modo Unicode esperan que haya búferes que contengan datos UTF-16 almacenados como de tipo wchar_t. Si el archivo está codificado como UTF-8, los datos UTF-16 se traducen a UTF-8 cuando se escriben, y el contenido codificado en UTF-8 del archivo se traduce a UTF-16 cuando se lee. Si se intenta leer o escribir un número impar de bytes en el modo Unicode, se producirá un error de validación de parámetros. Para leer o escribir datos almacenados en el programa como UTF-8, use un modo de archivo binario o de texto en lugar de un modo Unicode. Cualquier traducción de codificación que sea necesaria es su responsabilidad.

Si el archivo ya existe y está abierto para lectura o para anexar, la marca de orden de bytes (BOM), si está presente en el archivo, determina la codificación. La codificación de BOM tiene prioridad sobre la codificación especificada por el indicador ccs. La codificación de ccs solo se usa cuando no hay BOM presente o el archivo es nuevo.

Nota

La detección de BOM solo se aplica a los archivos abiertos en modo Unicode (es decir, pasando el indicador de ccs).

La tabla siguiente resume los modos que se utilizan para los distintos marcadores de ccs especificados en fopen y las marcas de orden de bytes en el archivo.

Codificaciones utilizadas basadas en el indicador de ccs y BOM

Marca de ccs	Ninguna BOM (o archivo nuevo)	BOM: UTF-8	BOM: UTF-16
UNICODE	UTF-16LE	UTF-8	UTF-16LE
UTF-8	UTF-8	UTF-8	UTF-16LE
UTF-16LE	UTF-16LE	UTF-8	UTF-16LE

Los archivos abiertos para escribir en el modo Unicode tienen una BOM escriba automáticamente.

Si mode es "a, ccs=<encoding>", fopen primero intenta abrir el archivo con acceso tanto de lectura como de escritura. Si esto se realiza correctamente, la función lee la BOM para determinar la codificación del archivo; si da error, la función utiliza la codificación predeterminada del archivo. En cualquier caso, fopen abrirá de nuevo el archivo solo con acceso de escritura. (Esto se aplica al modo a solo, no al modo a+).

Asignaciones de rutina de texto genérico

Rutina TCHAR.H	_UNICODE y _MBCS no definidos	_MBCS definido	_UNICODE definido
_tfopen	fopen	fopen	_wfopen

La cadena de caracteres mode especifica el tipo de acceso solicitado para el archivo, como se muestra a continuación:

"r"
Abre para lectura. Si el archivo no existe o no se encuentra, la llamada de fopen falla.
"w"
Abre un archivo vacío para escritura. Si el archivo especificado existe, se destruye su contenido.
"a"
Abre para escritura al final del archivo (anexo) sin eliminar el marcador de fin de archivo (EOF) antes de que se escriban nuevos datos en el archivo. Crea el archivo si no existe.
"r+"
Abre para lectura y escritura. El archivo debe existir.
"w+"
Abre un archivo vacío para lectura y escritura. Si el archivo existe, se destruye su contenido.
"a+"
Se abre para lectura y anexado. La operación de anexado incluye la eliminación del marcador EOF antes de que los nuevos datos se escriban en el archivo. El marcador EOF no se restablece una vez completada la escritura. Crea el archivo si no existe.

Cuando un archivo se abre mediante el tipo de acceso de "a" o el tipo de acceso de "a+", todas las operaciones de escritura aparecen al final del archivo. El puntero de archivo se puede mover mediante fseek o rewind, pero se desplaza siempre al final del archivo antes de que se realice cualquier operación de escritura. Por consiguiente, los datos existentes no pueden sobrescribirse.

El modo de "a" no quita el marcador EOF antes de que se anexe al archivo. Una vez realizado el anexado, el comando TYPE de MS-DOS solo muestra los datos hasta el marcador EOF original, y no los datos anexados al archivo. Antes de que se anexe al archivo, el modo "a+" elimina el marcador EOF. Después de anexar, el comando TYPE de MS-DOS muestra todos los datos del archivo. El modo "a+" se requiere para anexar a un archivo de streaming terminado con el marcador EOF CTRL+Z.

Cuando se especifica el tipo de acceso "r+", "w+" o "a+", se permiten la lectura y la escritura (el archivo está abierto para "actualización"). Sin embargo, cuando cambie de lectura a la escritura, la operación de entrada debe encontrar un marcador EOF. Si no hay ningún EOF, debe utilizar una llamada intermedia a una función de posición del archivo. Las funciones de posición de archivo son fsetpos, fseek y rewind. Cuando cambie de escritura a lectura, debe utilizar una llamada intermedia a fflush o una función de posicionamiento del archivo.

Además de los valores anteriores, los caracteres siguientes se pueden anexar a mode para especificar el modo de traducción de los caracteres de nueva línea.

t
Abra en modo de texto (traducido). En este modo, CTRL+Z se interpreta como un carácter EOF en entrada. En los archivos abiertos para lectura/escritura mediante "a+", fopen comprueba un CTRL+Z al final del archivo y lo elimina, si es posible. Esto se hace porque utilizar fseek y ftell para desplazarse por un archivo que finaliza con CTRL+Z puede hacer que fseek se comporte de forma incorrecta cerca del final del archivo.

En modo de texto, las combinaciones de retorno de carro y avance de línea se traducen en avances de línea únicos en la entrada, y los caracteres de avance de línea se convierten en combinaciones de retorno de carro y avance de línea en la salida. Cuando una función de E/S de flujo Unicode funciona en el modo de texto (valor predeterminado), se asume que el flujo de origen o de destino son una secuencia de caracteres multibyte. Por consiguiente, las funciones de entrada y flujo de Unicode convierten los caracteres multibyte en caracteres anchos (como si por una llamada a la función de mbtowc). Por la misma razón, las funciones de salida y flujo Unicode convierten los caracteres anchos en caracteres multibyte (como si se realizara una llamada a la función de wctomb).

b
Abra en modo binario (sin traducir); las traducciones que implican los caracteres de retorno de carro y avance de línea se suprimen.

Si no se especifica t o b en mode, el modo de traducción predeterminado está definido por la variable global _fmode. Si se agrega t o b como prefijo al argumento, se produce un error en la función y devuelve NULL.

Para obtener más información sobre cómo utilizar los modos binario y de texto en Unicode y la E/S de flujo multibyte, vea E/S de archivo en modo texto y en modo binario y E/S de secuencias Unicode en los modos binario y de texto.

c
Habilite la marca de confirmación para el filename asociado para que el contenido del búfer del archivo se escriba directamente en disco si se llama a fflush o a _flushall.
n
Restaure la marca de confirmación para el filename asociado a "no-commit". Este es el valor predeterminado. También invalida la marca global de confirmación si vincula el programa a COMMODE.OBJ. El valor predeterminado de la marca global de confirmación es "no-commit" a menos que explícitamente vincule el programa a COMMODE.OBJ (vea Opciones de vínculo).
N
Especifica que el archivo no se hereda mediante procesos secundarios.
S
Especifica que el almacenamiento en caché está optimizado para el acceso secuencial (pero no restringido a este) desde el disco.
R
Especifica que el almacenamiento en caché está optimizado para el acceso aleatorio (pero no restringido a este) desde el disco.
T
Especifica un archivo como temporal. Si es posible, no se vuelca en el disco.
D
Especifica un archivo como temporal. Se elimina cuando se cierra el puntero del último archivo.
ccs=ENCODING
Especifica el juego de caracteres codificados para utilizar (UTF-8, UTF-16LE, o UNICODE) para este archivo. Deje sin especificar si desea la codificación ANSI.

Los caracteres válidos para la cadena mode que se utiliza en fopen y _fdopen corresponde a los argumentos oflag que se usan en _open y _sopen, como se muestra a continuación:

Caracteres en cadena de modo	Valor oflag equivalente para _open/_sopen
a	_O_WRONLY \| _O_APPEND (normalmente _O_WRONLY \| _O_CREAT \| _O_APPEND)
a+	_O_RDWR \| _O_APPEND(normalmente _O_RDWR \| _O_APPEND \| _O_CREAT )
r	_O_RDONLY
r+	_O_RDWR
w	_O_WRONLY(normalmente _O_WRONLY \| _O_CREAT \| _O_TRUNC)
w+	_O_RDWR(normalmente _O_RDWR \| _O_CREAT \| _O_TRUNC)
b	_O_BINARY
t	_O_TEXT
c	Ninguna
n	Ninguna
S	_O_SEQUENTIAL
R	_O_RANDOM
T	_O_SHORTLIVED
D	_O_TEMPORARY
ccs=UNICODE	_O_WTEXT
ccs=UTF-8	_O_UTF8
ccs=UTF-16LE	_O_UTF16

Si usa el modo rb, no tiene que transportar código y espera leer la mayor parte de un archivo grande o no le preocupa el rendimiento de la red, también puede considerar si usar archivos Win32 asignados con memoria como una opción.

Requisitos

Función	Encabezado necesario
fopen	<stdio.h>
_wfopen	<stdio.h> o <wchar.h>

_wfopen es una extensión de Microsoft. Para obtener más información sobre la compatibilidad, vea Compatibilidad.

Las opciones c, n, t, S, R, T y D mode son extensiones de Microsoft para fopen y _fdopen y no deben usarse si desea usarse la portabilidad ANSI.

Ejemplo

El siguiente programa abre dos archivos. Utiliza fclose para cerrar el primer archivo y _fcloseall para cerrar todos los archivos restantes.

// crt_fopen.c
// compile with: /W3
// This program opens two files. It uses
// fclose to close the first file and
// _fcloseall to close all remaining files.

#include <stdio.h>

FILE *stream, *stream2;

int main( void )
{
   int numclosed;

   // Open for read (will fail if file "crt_fopen.c" does not exist)
   if( (stream  = fopen( "crt_fopen.c", "r" )) == NULL ) // C4996
   // Note: fopen is deprecated; consider using fopen_s instead
      printf( "The file 'crt_fopen.c' was not opened\n" );
   else
      printf( "The file 'crt_fopen.c' was opened\n" );

   // Open for write 
   if( (stream2 = fopen( "data2", "w+" )) == NULL ) // C4996
      printf( "The file 'data2' was not opened\n" );
   else
      printf( "The file 'data2' was opened\n" );

   // Close stream if it is not NULL 
   if( stream)
   {
      if ( fclose( stream ) )
      {
         printf( "The file 'crt_fopen.c' was not closed\n" );
      }
   }

   // All other files are closed: 
   numclosed = _fcloseall( );
   printf( "Number of files closed by _fcloseall: %u\n", numclosed );
}

El siguiente programa crea un archivo (o sobrescribe uno si existe), en el modo de texto con codificación Unicode. A continuación, escribe dos cadenas en el archivo y cierra el archivo. El resultado es un archivo denominado _wfopen_test.xml, que contiene los datos de la sección de salida.

// crt__wfopen.c
// compile with: /W3
// This program creates a file (or overwrites one if
// it exists), in text mode using Unicode encoding.
// It then writes two strings into the file
// and then closes the file.
 
#include <stdio.h>
#include <stddef.h>
#include <stdlib.h>
#include <wchar.h>

#define BUFFER_SIZE 50

int main(int argc, char** argv)
{
wchar_t str[BUFFER_SIZE];
size_t  strSize;
FILE*   fileHandle;

    // Create an the xml file in text and Unicode encoding mode.
    if ((fileHandle = _wfopen( L"_wfopen_test.xml",L"wt+,ccs=UNICODE")) == NULL) // C4996
    // Note: _wfopen is deprecated; consider using _wfopen_s instead
    {
        wprintf(L"_wfopen failed!\n");
        return(0);
    }

    // Write a string into the file.
    wcscpy_s(str, sizeof(str)/sizeof(wchar_t), L"<xmlTag>\n");
    strSize = wcslen(str);
    if (fwrite(str, sizeof(wchar_t), strSize, fileHandle) != strSize)
    {
        wprintf(L"fwrite failed!\n");
    }

    // Write a string into the file.
    wcscpy_s(str, sizeof(str)/sizeof(wchar_t), L"</xmlTag>");
    strSize = wcslen(str);
    if (fwrite(str, sizeof(wchar_t), strSize, fileHandle) != strSize)
    {
        wprintf(L"fwrite failed!\n");
    }

    // Close the file.
    if (fclose(fileHandle))
    {
        wprintf(L"fclose failed!\n");
    }
    return 0;
}