Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function writes data to a file, starting at the position indicated by the file pointer. After the write operation has been completed, the file pointer is adjusted by the number of bytes written.

A RAPI version of this function exists called CeWriteFile (RAPI).

Syntax 

BOOL WriteFile( 
  HANDLE 
hFile, 
  LPCVOID 
lpBuffer, 
  DWORD 
nNumberOfBytesToWrite, 
  LPDWORD 
lpNumberOfBytesWritten, 
  LPOVERLAPPED 
lpOverlapped
);

Parameters

hFile

[in] Handle to the file to be written to. The file handle must have been created with GENERIC_WRITE access to the file.

lpBuffer

[in] Pointer to the buffer containing the data to write to the file.

nNumberOfBytesToWrite

[in] Number of bytes to write to the file.

A value of zero specifies a null write operation. A null write operation does not write any bytes, but does cause the time stamp to change. This function does not truncate the file. To truncate or extend a file, use the SetEndOfFilefunction.

lpNumberOfBytesWritten

[out] Pointer to the number of bytes written by this function call. This function sets this value to zero before taking action or checking errors.

lpOverlapped

[in] Unsupported. Set to NULL.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

If part of the file is locked by another process and the write operation overlaps the locked portion, this function fails.

Accessing the output buffer while a write operation is using the buffer can corrupt the data written from that buffer. Applications must not read from, write to, reallocate, or free the output buffer that a write operation is using until the write operation completes.

Requirements

Header winbase.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also