MsiGetTargetPathA 関数 (msiquery.h)

[アーティクル]
08/25/2023

MsiGetTargetPath 関数は、ディレクトリテーブル内のフォルダーの完全なターゲットパスを返します。

構文

UINT MsiGetTargetPathA(
  [in]      MSIHANDLE hInstall,
  [in]      LPCSTR    szFolder,
  [out]     LPSTR     szPathBuf,
  [in, out] LPDWORD   pcchPathBuf
);

パラメーター

[in] hInstall

DLL カスタムアクションに対して提供されるインストール、または MsiOpenPackage、MsiOpenPackageEx、または MsiOpenProduct を使用して取得されたインストールを処理します。

[in] szFolder

ディレクトリテーブルのレコードを指定する null で終わる文字列。ディレクトリがルートディレクトリの場合は、DefaultDir 列の値を指定できます。それ以外の場合は、ディレクトリ列の値である必要があります。

[out] szPathBuf

null で終了した完全なターゲットパスを受け取るバッファーへのポインター。 szPathBuf に null (値=0) を渡してバッファーのサイズを判断しないでください。バッファーのサイズを取得するには、空の文字列 (""など) を渡します。その後、関数は ERROR_MORE_DATAを返し、 pcchPathBuf には、終端の null 文字を含めず、TCHAR に必要なバッファーサイズが含まれます。 ERROR_SUCCESSが返された場合、 pcchPathBuf には、終端の null 文字を含まない、バッファーに書き込まれた TCHAR の数が含まれます。

[in, out] pcchPathBuf

変数 szPathBuf が指すバッファーのサイズ (TCHAR) を指定する変数へのポインター関数がERROR_SUCCESSを返すと、この変数には、終端の null 文字を含まない、szPathBuf にコピーされたデータのサイズが含まれます。 szPathBuf が十分な大きさでない場合、関数は ERROR_MORE_DATAを返し、pcchPathBuf が指す変数に、終端の null 文字を含まない必要なサイズを格納します。

戻り値

MsiGetTargetPath 関数は、次の値を返します。

解説

ERROR_MORE_DATAが返された場合、ポインターであるパラメーターは、文字列を保持するために必要なバッファーのサイズを指定します。 ERROR_SUCCESSが返された場合、文字列バッファーに書き込まれた文字数が返されます。そのため、バッファーを指定するパラメーターに空の文字列 (""など) を渡すことで、バッファーのサイズを取得できます。 Null (値=0) を渡してバッファーのサイズを判断しないでください。

この関数を呼び出す前に、インストーラーで最初に CostInitialize アクション、 FileCost アクション、および CostFinalize アクションを実行する必要があります。詳細については、「プログラムからのデータベース関数の呼び出し」を参照してください。

MsiGetTargetPath は、インストールでターゲットの現在の場所が使用できない場合に、パッケージで作成されたターゲットディレクトリの既定のパスを返します。たとえば、メンテナンスインストール中にネットワークの場所にあるターゲットディレクトリを使用できない場合、インストーラーはターゲットディレクトリパスを既定値にリセットします。この場合、ターゲットディレクトリの実際のパスを取得するには、検索されたディレクトリに以前にインストールされていることがわかっているコンポーネントに対して MsiProvideComponent を呼び出し、 dwInstallMode を INSTALLMODE_NODETECTION に設定します。

詳細については、「プログラムからのデータベース関数の呼び出し」を参照してください。

関数が失敗した場合は、 MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。

注意

msiquery.h ヘッダーは、MSIGetTargetPath をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件


サポートされている最小のクライアント	Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows Server 2008 または Windows Vista の Windows インストーラー 4.0 または Windows インストーラー 4.5。 Windows Server 2003 または Windows XP の Windows インストーラー
対象プラットフォーム	Windows
ヘッダー	msiquery.h
Library	Msi.lib
[DLL]	Msi.dll

MsiGetTargetPathA 関数 (msiquery.h)

構文

パラメーター

戻り値

解説

要件

関連項目

フィードバック

フィードバック

その他のリソース