MsiDatabaseGetPrimaryKeysA 関数 (msiquery.h)

MsiDatabaseGetPrimaryKeys 関数は、指定されたテーブルのすべての主キー列の名前を含むレコードを返します。 この関数は、 MsiCloseHandle を使用して閉じる必要があるハンドルを返します。

構文

UINT MsiDatabaseGetPrimaryKeysA(
  [in]  MSIHANDLE hDatabase,
  [in]  LPCSTR    szTableName,
  [out] MSIHANDLE *phRecord
);

パラメーター

[in] hDatabase

データベースへのハンドル。 「データベース ハンドルの取得」を参照してください。

[in] szTableName

主キー名の取得元となるテーブルの名前を指定します。

[out] phRecord

主キー名を保持するレコードのハンドルへのポインター。

戻り値

この関数は UINT を返します。

注釈

返されるレコードのフィールド数は、 MsiDatabaseGetPrimaryKeys 関数によって返される主キー列の数です。 返されるレコードには、Field (0) のテーブル名と、後続のフィールドの主キー名を構成する列名が含まれます。 これらの主キー名は、フィールドの列番号に対応します。

この関数は、 _Tables テーブル または _Columns テーブルでは使用できません。

PMSIHANDLE 型の変数は、インストーラーがスコープ外に出ると PMSIHANDLE オブジェクトを閉じるのに対し、 MsiCloseHandle を呼び出して MSIHANDLE オブジェクトを閉じる必要があるため、PMSIHANDLE 型の変数を使用することをお勧めします。 詳細については、「Windows インストーラーのベスト プラクティス」の「HANDLE の代わりに PMSIHANDLE を使用する」セクションを参照してください。

注意

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

要件

要件	値
サポートされている最小のクライアント	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

こちらもご覧ください

一般的なデータベース アクセス関数