SetEndOfFile

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function moves the end-of-file position for the specified file to the current position of the file pointer. A RAPI version of this function exists called CeSetEndOfFile (RAPI).

Syntax

BOOL SetEndOfFile( 
  HANDLE hFile
);

Parameters

• hFile
  [in] Handle to the file to have its end-of-file (EOF) position moved. The file handle must have been created with GENERIC_WRITE access to the file.

Return Value

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

Remarks

You cannot use this function with a handle to a nonseeking device, such as a communications device.

Use this function to truncate or extend a file. If the file is extended, the contents of the file between the old EOF position and the new position are not defined. Call the SetFilePointer function to set the file pointer to the desired position before setting the end of the file.

If you called the CreateFileMapping function to create a file-mapping object for hFile, you must first call the UnmapViewOfFile funciton to unmap all views and call the CloseHandle function to close the file-mapping object before you call this function.

Requirements

See Also

Reference

File I/O Functions
CreateFile
CreateFileMapping
UnmapViewOfFile
SetFilePointer