MsiRecordGetStringA 関数 (msiquery.h)
MsiRecordGetString 関数は、レコード フィールドの文字列値を返します。
構文
UINT MsiRecordGetStringA(
[in] MSIHANDLE hRecord,
[in] UINT iField,
[out] LPSTR szValueBuf,
[in, out] LPDWORD pcchValueBuf
);
パラメーター
[in] hRecord
レコードへのハンドル。
[in] iField
要求されたフィールドを指定します。
[out] szValueBuf
レコード フィールドの値を含む null で終わる文字列を受け取るバッファーへのポインター。 szValueBufに null (値 =0) を渡してバッファーのサイズを決定しないでください。 空の文字列 (""など) を渡すことで、バッファーのサイズを取得できます。 次に、この関数は ERROR_MORE_DATA を返し、pcchValueBuf は、終端の null 文字を含まない、TCHAR で必要なバッファー サイズを含みます。 ERROR_SUCCESSが返された場合、pcchValueBuf には、バッファーに書き込まれた TCHAR の数、終端の null 文字は含まれません。
[in, out] pcchValueBuf
szValueBuf
戻り値
MsiRecordGetString 関数は、次のいずれかの値を返します。
備考
ERROR_MORE_DATA が返された場合、ポインターであるパラメーターは、文字列を保持するために必要なバッファーのサイズを指定します。 ERROR_SUCCESS が返された場合、文字列バッファーに書き込まれた文字数が返されます。 バッファーのサイズを取得するには、szValueBuf として 1 文字のバッファーのアドレスを渡し、pcchValueBuf を 0 にしてバッファーのサイズを指定します。 これにより、関数によって返される文字列値がバッファーに収まらないようにします。 Null (値 = 0) を渡してバッファーのサイズを決定しないでください。
手記
msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして MsiRecordGetString を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | 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。 |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | msiquery.h |
ライブラリ | Msi.lib |
DLL | Msi.dll |