ホーム › System.ApplicationInstallationAndServicing › MsiDatabaseGetPrimaryKeysW

MsiDatabaseGetPrimaryKeysW

関数

指定テーブルの主キーの列名をレコードとして取得する。

DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiDatabaseGetPrimaryKeysW(
    MSIHANDLE hDatabase,
    LPCWSTR szTableName,
    MSIHANDLE* phRecord
);

パラメーター

名前	型	方向	説明
hDatabase	MSIHANDLE	in	データベースへのハンドル。 Obtaining a Database Handle を参照してください。
szTableName	LPCWSTR	in	主キー名を取得するテーブルの名前を指定します。
phRecord	MSIHANDLE*	inout	主キー名を保持するレコードのハンドルへのポインター。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

解説(Remarks)

返されるレコードのフィールド数は、 MsiDatabaseGetPrimaryKeys 関数が返す主キー列の数です。返されるレコードには、Field (0) にテーブル名が格納され、それ以降のフィールドに主キー名を構成する列名が格納されます。これらの主キー名は、各フィールドの列番号に対応します。

この関数は、 _Tables table または _Columns table には使用できません。

なお、PMSIHANDLE 型の変数を使用することをお勧めします。これは、インストーラーが PMSIHANDLE オブジェクトをスコープ外になった時点で閉じるのに対し、MSIHANDLE オブジェクトは MsiCloseHandle を呼び出して自分で閉じる必要があるためです。詳細については、Windows Installer Best Practices の Use PMSIHANDLE instead of HANDLE セクションを参照してください。

メモ

msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiDatabaseGetPrimaryKeys を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiDatabaseGetPrimaryKeysW(
    MSIHANDLE hDatabase,
    LPCWSTR szTableName,
    MSIHANDLE* phRecord
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiDatabaseGetPrimaryKeysW(
    uint hDatabase,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szTableName,   // LPCWSTR
    ref uint phRecord   // MSIHANDLE* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiDatabaseGetPrimaryKeysW(
    hDatabase As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szTableName As String,   ' LPCWSTR
    ByRef phRecord As UInteger   ' MSIHANDLE* in/out
) As UInteger
End Function

' hDatabase : MSIHANDLE
' szTableName : LPCWSTR
' phRecord : MSIHANDLE* in/out
Declare PtrSafe Function MsiDatabaseGetPrimaryKeysW Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal szTableName As LongPtr, _
    ByRef phRecord As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiDatabaseGetPrimaryKeysW = ctypes.windll.msi.MsiDatabaseGetPrimaryKeysW
MsiDatabaseGetPrimaryKeysW.restype = wintypes.DWORD
MsiDatabaseGetPrimaryKeysW.argtypes = [
    wintypes.DWORD,  # hDatabase : MSIHANDLE
    wintypes.LPCWSTR,  # szTableName : LPCWSTR
    ctypes.c_void_p,  # phRecord : MSIHANDLE* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDatabaseGetPrimaryKeysW = Fiddle::Function.new(
  lib['MsiDatabaseGetPrimaryKeysW'],
  [
    -Fiddle::TYPE_INT,  # hDatabase : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szTableName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # phRecord : MSIHANDLE* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiDatabaseGetPrimaryKeysW(
        hDatabase: u32,  // MSIHANDLE
        szTableName: *const u16,  // LPCWSTR
        phRecord: *mut u32  // MSIHANDLE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiDatabaseGetPrimaryKeysW(uint hDatabase, [MarshalAs(UnmanagedType.LPWStr)] string szTableName, ref uint phRecord);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDatabaseGetPrimaryKeysW' -Namespace Win32 -PassThru
# $api::MsiDatabaseGetPrimaryKeysW(hDatabase, szTableName, phRecord)

#uselib "msi.dll"
#func global MsiDatabaseGetPrimaryKeysW "MsiDatabaseGetPrimaryKeysW" wptr, wptr, wptr
; MsiDatabaseGetPrimaryKeysW hDatabase, szTableName, varptr(phRecord)   ; 戻り値は stat
; hDatabase : MSIHANDLE -> "wptr"
; szTableName : LPCWSTR -> "wptr"
; phRecord : MSIHANDLE* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiDatabaseGetPrimaryKeysW "MsiDatabaseGetPrimaryKeysW" int, wstr, var
; res = MsiDatabaseGetPrimaryKeysW(hDatabase, szTableName, phRecord)
; hDatabase : MSIHANDLE -> "int"
; szTableName : LPCWSTR -> "wstr"
; phRecord : MSIHANDLE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiDatabaseGetPrimaryKeysW "MsiDatabaseGetPrimaryKeysW" int, wstr, sptr
; res = MsiDatabaseGetPrimaryKeysW(hDatabase, szTableName, varptr(phRecord))
; hDatabase : MSIHANDLE -> "int"
; szTableName : LPCWSTR -> "wstr"
; phRecord : MSIHANDLE* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。