0 out of 2 rated this helpful - Rate this topic

FILE_RENAME_INFO structure

Applies to: desktop apps only

Contains the name to which the file should be renamed. Use only when calling SetFileInformationByHandle.

Syntax

typedef struct _FILE_RENAME_INFO {
  BOOL   ReplaceIfExists;
  HANDLE RootDirectory;
  DWORD  FileNameLength;
  WCHAR  FileName[1];
} FILE_RENAME_INFO, *PFILE_RENAME_INFO;

Members

ReplaceIfExists

TRUE to replace the file; otherwise, FALSE.

RootDirectory

A handle to the root directory in which the file to be renamed is located.

FileNameLength

The size of FileName in bytes.

FileName

The new file name.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Redistributable

Windows SDK on Windows Server 2003 and Windows XP.

Header

WinBase.h (include Windows.h);
FileExtd.h on Windows Server 2003 and Windows XP

See also

FILE_INFO_BY_HANDLE_CLASS
SetFileInformationByHandle

 

 

Send comments about this topic to Microsoft

Build date: 4/17/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ