FILE_RENAME_INFO構造体 (winbase.h)

ソース ファイルの名前を変更するターゲット名を格納します。 SetFileInformationByHandle を呼び出す場合にのみ使用します。

構文

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

Members

DUMMYUNIONNAME

DUMMYUNIONNAME.ReplaceIfExists

このフィールドは、 SetFileInformationByHandleFileInformationClass パラメーターが FileRenameInfo に設定されている場合に使用されます。 このフィールドが TRUE で、ターゲット ファイルが存在する場合、ターゲット ファイルはソース ファイルに置き換えられます。 このフィールドが FALSE で、ターゲット ファイルが存在する場合、操作はエラーを返します。

DUMMYUNIONNAME.Flags

このフィールドは、 SetFileInformationByHandleFileInformationClass パラメーターが FileRenameInfoEx に設定されている場合に使用されます。

ReplaceIfExists

RootDirectory

一般的なケースでは NULL に設定します。 FileName で相対名が指定されている場合、このフィールドは、新しい名前が解決されるディレクトリに対するハンドルにすることができます。

FileNameLength

FileName のサイズ (バイト単位)。 終端の null 文字は必要ありません。

FileName[1]

ファイルへの新しいパスを含む NUL で終わるワイド文字文字列。 値は次のいずれかを指定できます。

  • 絶対パス (ドライブ、ディレクトリ、ファイル名)。
  • プロセスの現在のディレクトリに対する相対パス。
  • で始まる NTFS ファイル ストリームの新しい名前。

Requirements

Requirement 価値
サポートされる最小クライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
ヘッダー winbase.h (Windows.h を含む)
再頒布可能 Windows Server 2003 および Windows XP で SDK をWindowsします。

こちらも参照ください

FILE_INFO_BY_HANDLE_CLASS

SetFileInformationByHandle