ホーム › System.ApplicationInstallationAndServicing › MsiViewGetColumnInfo

MsiViewGetColumnInfo

関数

ビューの列名やデータ型などのカラム情報を取得する。

DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll
#include <windows.h>

DWORD MsiViewGetColumnInfo(
    MSIHANDLE hView,
    MSICOLINFO eColumnInfo,
    MSIHANDLE* phRecord
);

パラメーター

名前

型

方向

説明

hView

MSIHANDLE

列情報を取得する対象のビューへのハンドル。

eColumnInfo

MSICOLINFO

必要な情報の種類を示すフラグを指定します。このパラメーターは、次のいずれかの値である必要があります。

値	意味
MSICOLINFO_NAMES	列名が返されます。
MSICOLINFO_TYPES	列定義が返されます。

phRecord

MSIHANDLE*

inout

列情報のデータレコードを受け取るハンドルへのポインター。

戻り値の型: DWORD

公式ドキュメント

MsiViewGetColumnInfo 関数は、列名または列定義を含むレコードを返します。この関数が返すハンドルは、MsiCloseHandle を使用して閉じる必要があります。

戻り値

メモリが不足している状況では、この関数が STATUS_NO_MEMORY 例外を発生させることがある点に注意してください。

解説(Remarks)

MsiViewGetColumnInfo が返す列の記述は、次のセクションで説明されている形式です: Column Definition Format。各列は、対応するレコードフィールド内の文字列によって記述されます。定義文字列は、データ型を表す 1 文字と、それに続く列の幅(該当する場合は文字数、それ以外の場合はバイト数)で構成されます。幅が 0 の場合は、幅が無制限であること(たとえば長いテキストフィールドやストリーム)を示します。大文字は、その列で null 値が許可されていることを示します。

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

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

各言語での呼び出し定義

// msi.dll
#include <windows.h>

DWORD MsiViewGetColumnInfo(
    MSIHANDLE hView,
    MSICOLINFO eColumnInfo,
    MSIHANDLE* phRecord
);

[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiViewGetColumnInfo(
    uint hView,   // MSIHANDLE
    int eColumnInfo,   // MSICOLINFO
    ref uint phRecord   // MSIHANDLE* in/out
);

<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiViewGetColumnInfo(
    hView As UInteger,   ' MSIHANDLE
    eColumnInfo As Integer,   ' MSICOLINFO
    ByRef phRecord As UInteger   ' MSIHANDLE* in/out
) As UInteger
End Function

' hView : MSIHANDLE
' eColumnInfo : MSICOLINFO
' phRecord : MSIHANDLE* in/out
Declare PtrSafe Function MsiViewGetColumnInfo Lib "msi" ( _
    ByVal hView As Long, _
    ByVal eColumnInfo As Long, _
    ByRef phRecord As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiViewGetColumnInfo = ctypes.windll.msi.MsiViewGetColumnInfo
MsiViewGetColumnInfo.restype = wintypes.DWORD
MsiViewGetColumnInfo.argtypes = [
    wintypes.DWORD,  # hView : MSIHANDLE
    ctypes.c_int,  # eColumnInfo : MSICOLINFO
    ctypes.c_void_p,  # phRecord : MSIHANDLE* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiViewGetColumnInfo = Fiddle::Function.new(
  lib['MsiViewGetColumnInfo'],
  [
    -Fiddle::TYPE_INT,  # hView : MSIHANDLE
    Fiddle::TYPE_INT,  # eColumnInfo : MSICOLINFO
    Fiddle::TYPE_VOIDP,  # phRecord : MSIHANDLE* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiViewGetColumnInfo(
        hView: u32,  // MSIHANDLE
        eColumnInfo: i32,  // MSICOLINFO
        phRecord: *mut u32  // MSIHANDLE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll")]
public static extern uint MsiViewGetColumnInfo(uint hView, int eColumnInfo, ref uint phRecord);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiViewGetColumnInfo' -Namespace Win32 -PassThru
# $api::MsiViewGetColumnInfo(hView, eColumnInfo, phRecord)

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

出力引数:

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