CopyFile エレメント

説明
ターゲットマシンの既存のファイルをコピーするか移動する、またはインストール中のファイルを別の宛先にコピーします。このエレメントが File エレメントの下にネストされる時には、もしインストールまたは削除のためにファイルの親コンポーネントが選ばれていれば、親ファイルはインストールされて そして 指定された宛先にコピーされるでしょう。 このエレメントが Component エレメントの下にネストされて FileId 属性が全然指定されない時には、コピーか移動するファイルはすでにターゲットマシンにあるに違いありません。 このエレメントが Component エレメントの下にネストされて FileId 属性が指定される時には、もしインストールまたは削除のために親コンポーネントが選ばれていれば、指定されたファイルがインストールされて そして 指定された宛先にコピーされます(親コンポーネントのインストール状態によって 違うコンポーネントのファイルのコピーをコントロールするために、このオプションを使用してください)。 もし指定された宛先ディレクトリーがオリジナル ファイルが入っているディレクトリーと同じで、依頼されたソース ファイルの名前がオリジナルと同じならば、アクションは全く起こりません。
Windows Installer リファレンス
DuplicateFile Table, MoveFile Table
Component, File
タグの内部テキスト
なし
なし
属性
名前 タイプ 説明 必須
Id String この特定のエントリーを識別するのに使用されるプライマリキー。 Yes
Delete YesNoType エレメントが File エレメントの下にネストされるか FileId 属性が指定される場合には、この属性は指定できません。 その他の場合には、もし属性が指定されないと デフォルト値は "no" で、ファイルはコピーされて移動はされません。 コピーの代わりにファイルを移動する(従って ソース ファイルを消去する)為には 値を "yes" に セットして下さい。  
DestinationDirectory String この値を、ターゲット マシンで既存のファイルの宛先ディレクトリーにセットして下さい。 このディレクトリーは、作成時にインストーラー データベース中に存在していなければなりません。 この属性は、DestinationProperty と連係して指定される事はできません。  
DestinationLongName LongFileNameType この属性は使用を避ける事が望まれています。代わりに DestinationName 属性を使って下さい。  
DestinationName LongFileNameType WiX toolset の前のバージョンにおいて、この属性は短いファイル名を指定しました。 現在 この値を、移動かコピーされた後 オリジナル ファイルに与えられるべきローカライズ可能な 名前にセットして下さい。 もしこの属性が指定されないと、宛先ファイルはソース ファイルと同じ名前を与えられます。 もし短いファイル名が指定されるならば、DestinationShortName 属性は指定されないかもしれません。 もし長いファイル名が指定されるならば、DestinationLongName 属性は指定されないかもしれません。 また、もしこの値が長いファイル名であるならば、DestinationShortName 属性は、WiX がユニークな短いファイル名を生成しようとすることを可能にするために省略されるかもしれません。 しかし、もしこの名前が別のファイルと相反しているか、または短いファイル名を手動で指定することを望むならば、DestinationShortName 属性は指定されるかもしれません。  
DestinationProperty String この値を、宛先ディレクトリーのフルパスになる値を持つプロパティにセットして下さい。 プロパティは作成時にインストーラーデータベース中に存在する必要はありません。 インストール時にカスタムアクションによって、コマンドラインなどで、作成されるかもしれません。 この属性は、DestinationDirectory と連係して指定される事はできません。  
DestinationShortName ShortFileNameType 8.3 フォーマットのファイルの短いファイル名。 もし生成された短いファイル名の間に矛盾があるか、または短いファイル名を手動で指定したい時にだけ、この属性は設定されるべきです。  
FileId String エレメントが File エレメントの下にネストされる場合には、この属性は指定できません。 この属性の値を、親コンポーネントのインストール状態に基づいて別のコンポーネントからコピーする ファイルの識別子にセットして下さい。  
SourceDirectory String エレメントが File エレメントの下にネストされるか FileId 属性が指定される場合には、この属性は 指定できません。 この値を、ターゲット マシンで既存のファイルをコピーか移動するソース ディレクトリーにセットして下さい。 このディレクトリーは、作成時にインストーラー データベース中に存在していなければなりません。 この属性は、SourceProperty と連係して指定される事はできません。  
SourceName WildCardLongFileNameType エレメントが File エレメントの下にネストされるか FileId 属性が指定される場合には、この属性は 指定できません。 この値を、コピーか移動されるべきファイルのローカライズ可能な名前にセットして下さい。 ワイルドカードに一致するすべてのファイルが 指定されたディレクトリーから削除されます。 値は、すべての文字に関して 1 文字なら "?" 0 個以上の出現で "*" のワイルドカードも含んでいる かもしれないファイル名です。 もしこの属性が指定されない(そして このエレメントが File エレメントの下にネストされていなくて FileId 属性を指定していない)なら、SourceProperty 属性はソース ファイル名のフルパスになる プロパティの名前にセットされるべきです。 もしこの属性の値がワイルドカード "*" を含み DestinationName 属性が指定されると、移動されるか コピーされるすべてのファイルが ソースから名前を持ち続けます。  
SourceProperty String エレメントが File エレメントの下にネストされるか FileId 属性が指定される場合には、この属性は 指定できません。 この値を、ソース ディレクトリーのフルパス(あるいは SourceName が指定されない場合にファイル 名を含んでいるフルパス)になる値を持つプロパティにセットして下さい。 プロパティは作成時にインストーラーデータベース中に存在する必要はありません。 インストール時にカスタムアクションによって、コマンドラインなどで、作成されるかもしれません。 この属性は SourceDirectory と連係して指定される事はできません。  
See Also
Wix Schema, RemoveFile