MsiRecordGetStringW 関数 (msiquery.h)

MsiRecordGetString 関数は、レコード フィールドの文字列値を返します。

構文

UINT MsiRecordGetStringW(
  [in]      MSIHANDLE hRecord,
  [in]      UINT      iField,
  [out]     LPWSTR    szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

パラメーター

[in] hRecord

レコードへのハンドル。

[in] iField

要求されたフィールドを指定します。

[out] szValueBuf

レコード フィールドの値を含む null で終わる文字列を受け取るバッファーへのポインター。 szValueBuf に null (値=0) を渡してバッファーのサイズを判断しないでください。 バッファーのサイズを取得するには、空の文字列 (""など) を渡します。 その後、関数は ERROR_MORE_DATA を返し、 pcchValueBuf には、終端の null 文字を含めず、TCHAR に必要なバッファー サイズが含まれます。 ERROR_SUCCESSが返された場合、pcchValueBuf には、終端の null 文字を含まない、バッファーに書き込まれた TCHAR の数が含まれます。

[in, out] pcchValueBuf

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

戻り値

MsiRecordGetString 関数は、次のいずれかの値を返します。

注釈

ERROR_MORE_DATAが返された場合、ポインターである パラメーターは、文字列を保持するために必要なバッファーのサイズを指定します。 ERROR_SUCCESSが返されると、文字列バッファーに書き込まれた文字数が返されます。 バッファーのサイズを取得するには、1 文字のバッファーのアドレスを szValueBuf として渡し、 pcchValueBuf を 0 にしてバッファーのサイズを指定します。 これにより、関数によって返される文字列値がバッファーに収まらないようにします。 Null (値=0) を渡してバッファーのサイズを判断しないでください。

注意

msiquery.h ヘッダーは、MSIRecordGetString をエイリアスとして定義し、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
ヘッダー	msiquery.h
Library	Msi.lib
[DLL]	Msi.dll

こちらもご覧ください

Windows インストーラー関数の引数として Null を渡す

レコード処理関数