SetupQueueRenameA 関数 (setupapi.h)
[この機能は、「要件」セクションに示されているオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 SetupAPI は、アプリケーションのインストールに使用されなくなりました。 代わりに、アプリケーション インストーラーを開発するために Windows インストーラーを使用します。 SetupAPI は、デバイス ドライバーのインストールに引き続き使用されます。]
SetupQueueRename 関数は、セットアップ ファイル キューに個々のファイル名変更操作を配置します。
構文
WINSETUPAPI BOOL SetupQueueRenameA(
[in] HSPFILEQ QueueHandle,
[in] PCSTR SourcePath,
[in] PCSTR SourceFilename,
[in] PCSTR TargetPath,
[in] PCSTR TargetFilename
);
パラメーター
[in] QueueHandle
SetupOpenFileQueue によって返されるセットアップ ファイル キューを処理します。
[in] SourcePath
名前を変更するファイルのソース パスを指定する null で終わる文字列へのポインター。 SourceFileName が指定されていない場合、SourcePath は完全なパスであると見なされます。
[in] SourceFilename
名前を変更するファイルのファイル名部分を指定する null で終わる文字列へのポインター。 指定しない場合、 SourcePath は完全なパスです。
[in] TargetPath
ターゲット ディレクトリを指定する null で終わる文字列へのポインター。 このパラメーターを指定すると、名前の変更操作は実際には移動操作になります。 TargetPath が指定されていない場合、ファイルの名前は変更されますが、現在の場所に残ります。
[in] TargetFilename
ソース ファイルの新しい名前を指定する null で終わる文字列へのポインター。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
名前変更操作は固定メディアで行われると見なされるため、キューがコミットされるときにユーザーにプロンプトは表示されません。
注意
setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupQueueRename を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | setupapi.h |
| Library | Setupapi.lib |
| [DLL] | Setupapi.dll |