MsiGetTargetPathA 関数 (msiquery.h)
MsiGetTargetPath 関数は、Directory テーブル内のフォルダーの完全なターゲット パスを返します。
構文
UINT MsiGetTargetPathA(
[in] MSIHANDLE hInstall,
[in] LPCSTR szFolder,
[out] LPSTR szPathBuf,
[in, out] LPDWORD pcchPathBuf
);
パラメーター
[in] hInstall
DLL カスタム アクションに提供されるインストール、または MsiOpenPackage、
[in] szFolder
ディレクトリ テーブルのレコードを指定する null で終わる文字列。 ディレクトリがルート ディレクトリの場合は、DefaultDir 列の値を指定できます。 それ以外の場合は、ディレクトリ列の値である必要があります。
[out] szPathBuf
null 終端の完全なターゲット パスを受け取るバッファーへのポインター。 szPathBufに null (値 =0) を渡してバッファーのサイズを決定しないでください。 空の文字列 (""など) を渡すことで、バッファーのサイズを取得できます。 次に、この関数はERROR_MORE_DATAを返し、pcchPathBuf、終端の null 文字を含まない、TCHAR に必要なバッファー サイズが含まれます。 ERROR_SUCCESSが返された場合、pcchPathBuf には、バッファーに書き込まれた TCHAR の数 (終端の null 文字は含まれません) が含まれます。
[in, out] pcchPathBuf
szPathBuf 変数
戻り値
MsiGetTargetPath 関数は、次の値を返します。
備考
ERROR_MORE_DATAが返された場合、ポインターであるパラメーターは、文字列を保持するために必要なバッファーのサイズを指定します。 ERROR_SUCCESSが返された場合は、文字列バッファーに書き込まれた文字数が返されます。 そのため、バッファーを指定するパラメーターに空の文字列 ("") を渡すことで、バッファーのサイズを取得できます。 Null (値 = 0) を渡してバッファーのサイズを決定しないでください。
この関数を呼び出す前に、インストーラーは最初に
MsiGetTargetPath は、インストールでターゲットの現在の場所が使用できない場合に、パッケージで作成されたターゲット ディレクトリの既定のパスを返します。 たとえば、メンテナンス インストール中に、ネットワークの場所にあるターゲット ディレクトリ 使用できない場合、インストーラーはターゲット ディレクトリ パスを既定値にリセットします。 この場合、ターゲット ディレクトリの実際のパスを取得するには、以前に検索されたディレクトリにインストールされていることがわかっているコンポーネントの MsiProvideComponent
詳細については、「プログラムからのデータベース関数の呼び出し」を参照してください。
関数が失敗した場合は、MsiGetLastErrorRecordを使用して拡張エラー情報を取得できます。
手記
msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして MsiGetTargetPath を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | 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 インストーラー |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | msiquery.h |
| ライブラリ | Msi.lib |
| DLL | Msi.dll |