My.Computer.FileSystem.MoveFile メソッド

[アーティクル]
09/30/2008

更新 : 2007 年 11 月

ファイルを新しい位置に移動します。

' Usage
My.Computer.FileSystem.MoveFile(sourceFileName ,destinationFileName)
My.Computer.FileSystem.MoveFile(sourceFileName ,destinationFileName ,overwrite)
My.Computer.FileSystem.MoveFile(sourceFileName ,destinationFileName ,showUI)
My.Computer.FileSystem.MoveFile(sourceFileName ,destinationFileName ,showUI ,onUserCancel)
' Declaration
Public Sub MoveFile( _
   ByVal sourceFileName As String, _
   ByVal destinationFileName As String _
)
' -or-
Public Sub MoveFile( _
   ByVal sourceFileName As String, _
   ByVal destinationFileName As String, _
   ByVal overwrite As Boolean _
)
' -or-
Public Sub MoveFile( _
   ByVal sourceFileName As String, _
   ByVal destinationFileName As String, _
   ByVal showUI As UIOption _
)
' -or-
Public Sub MoveFile( _
   ByVal sourceFileName As String, _
   ByVal destinationFileName As String, _
   ByVal showUI As UIOption, _
   ByVal onUserCancel As UICancelOption _
)

パラメータ

sourceFileName
String です。移動するファイルのパスです。必ず指定します。
destinationFileName
String です。ファイルの移動先となるディレクトリのパスです。必ず指定します。
overwrite
Boolean です。既存のファイルを上書きするかどうかを指定します。既定値は False です。必ず指定します。
showUI
UIOption 列挙型です。操作の進行状況を視覚的に表示するかどうかを指定します。既定値は UIOption.OnlyErrorDialogs です。必ず指定します。
onUserCancel
UICancelOption 列挙型です。ユーザーが操作をキャンセルしたときに例外をスローするかどうかを指定します。既定値は UICancelOption.ThrowException です。必ず指定します。

例外

次の条件を満たす場合は、例外が発生する可能性があります。

パスが無効である。つまり、パスが長さ 0 の文字列である、パスに空白だけが含まれている、パスに無効な文字が含まれている、またはパスがデバイスパスである (\\.\ で始まる) (ArgumentException)。
ファイル名の末尾に円記号 (\) が付いている (ArgumentException)。
パスが Nothing であるため、有効ではない (ArgumentNullException)。
destinationFileName が Nothing または空の文字列である (ArgumentNullException)。
ソースファイルが有効でないか存在しない (FileNotFoundException)。
組み合わせたパスが既存のディレクトリを指していて、ターゲットファイルが既に存在し、かつ overwrite が False に設定されている。ターゲットディレクトリ内の同名のファイルが使用中である。ユーザーがファイルにアクセスするのに必要なアクセス許可を持っていない (IOException)。
パス内のファイル名またはディレクトリ名にコロン (:) が含まれているか、形式が無効である (NotSupportedException)。
onUserCancel が ThrowException に設定されているときに、ユーザーが操作をキャンセルしたか、不特定の I/O エラーが発生した (OperationCanceledException)。
パスがシステムで定義されている最大長を超えている (PathTooLongException)。
ユーザーがパスを表示するのに必要なアクセス許可を持っていない (SecurityException)。
ユーザーが必要なアクセス許可を持っていない (UnauthorizedAccessException)。

解説

ターゲット構造が存在しないときは、新たに作成されます。

MoveFile メソッドは、同じボリューム内でファイルを移動する場合にのみアクセス制御エントリ (ACE: Access Control Entry) を維持します。これには継承された ACE も含まれており、移動すると、それが直接 ACE になります (直接 ACE は継承された ACE よりも優先されます)。別のボリュームにファイルを移動する場合は、ACE はコピーされません。

処理手順

My.Computer.FileSystem.MoveFile メソッドに関連するタスクの例を次の表に示します。

目的	参照項目
ファイルを移動する	方法 : Visual Basic でファイルを移動する
ファイルのコレクションを移動する	方法 : Visual Basic でファイルのコレクションを移動する
ディレクトリの内容を移動する	方法 : Visual Basic でディレクトリの内容を移動する

使用例

この例では、 Test.txt というファイルを TestDir1 から TestDir2 に移動します。

My.Computer.FileSystem.MoveFile("C:\TestDir1\test.txt", "C:\TestDir2\test.txt")

この例では、 Test.txt というファイルを TestDir1 から TestDir2 に移動し、名前を Test2.txt に変更します。

My.Computer.FileSystem.MoveFile("C:\TestDir1\test.txt", "C:\TestDir2\test2.txt")

必要条件

名前空間 : Microsoft.VisualBasic.MyServices

クラス : FileSystemProxy (FileSystem へのアクセスを可能にします)

アセンブリ : Visual Basic ランタイムライブラリ (Microsoft.VisualBasic.dll 内)

プロジェクトの種類ごとの可用性

プロジェクトの種類	可用性
Windows アプリケーション	可
クラスライブラリ	可
コンソールアプリケーション	可
Windows コントロールライブラリ	可
Web コントロールライブラリ	可
Windows サービス	可
Web サイト	可

アクセス許可

次のアクセス許可が必要です。

アクセス許可	説明
EnvironmentPermission	すべての環境変数へのアクセスを制御します。関連する列挙値 : Unrestricted。
FileIOPermission	ファイルとフォルダへのアクセス許可を制御します。関連する列挙値 : Unrestricted。
RegistryPermission	レジストリ変数へのアクセスを制御します。関連する列挙値 : Unrestricted。
UIPermission	ユーザーインターフェイスとクリップボードに関係するアクセス許可を制御します。関連する列挙値 : SafeSubWindows。