Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiViewFetch

MsiViewFetch

関数
実行済みビューから次の行をレコードとして取得する。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiViewFetch(
    MSIHANDLE hView,
    MSIHANDLE* phRecord
);

パラメーター

名前方向説明
hViewMSIHANDLEin取得元のビューへのハンドル。
phRecordMSIHANDLE*inout取得されたレコードのハンドルへのポインター。

戻り値の型: DWORD

公式ドキュメント

MsiViewFetch 関数は、ビューから次の順次レコードを取得します。この関数が返すハンドルは、MsiCloseHandle を使用して閉じる必要があります。

戻り値

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

解説(Remarks)

MsiViewFetch 関数が ERROR_FUNCTION_FAILED を返す場合、事前に MsiViewExecute 関数が呼び出されていない可能性があります。結果セットにさらに行が存在する場合、 MsiViewFetch は、要求された列データを含むレコードへのハンドルとして phRecord を返します。それ以外の場合、phRecord は 0 になります。最大限のパフォーマンスを得るには、すべての取得に同じレコードを使用するか、スコープ外に出すことでレコードを解放してください。

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

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

各言語での呼び出し定義

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

DWORD MsiViewFetch(
    MSIHANDLE hView,
    MSIHANDLE* phRecord
);
[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiViewFetch(
    uint hView,   // MSIHANDLE
    ref uint phRecord   // MSIHANDLE* in/out
);
<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiViewFetch(
    hView As UInteger,   ' MSIHANDLE
    ByRef phRecord As UInteger   ' MSIHANDLE* in/out
) As UInteger
End Function
' hView : MSIHANDLE
' phRecord : MSIHANDLE* in/out
Declare PtrSafe Function MsiViewFetch Lib "msi" ( _
    ByVal hView 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

MsiViewFetch = ctypes.windll.msi.MsiViewFetch
MsiViewFetch.restype = wintypes.DWORD
MsiViewFetch.argtypes = [
    wintypes.DWORD,  # hView : MSIHANDLE
    ctypes.c_void_p,  # phRecord : MSIHANDLE* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiViewFetch = Fiddle::Function.new(
  lib['MsiViewFetch'],
  [
    -Fiddle::TYPE_INT,  # hView : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # phRecord : MSIHANDLE* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiViewFetch(
        hView: u32,  // MSIHANDLE
        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 MsiViewFetch(uint hView, ref uint phRecord);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiViewFetch' -Namespace Win32 -PassThru
# $api::MsiViewFetch(hView, phRecord)
#uselib "msi.dll"
#func global MsiViewFetch "MsiViewFetch" sptr, sptr
; MsiViewFetch hView, varptr(phRecord)   ; 戻り値は stat
; hView : MSIHANDLE -> "sptr"
; phRecord : MSIHANDLE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "msi.dll"
#cfunc global MsiViewFetch "MsiViewFetch" int, var
; res = MsiViewFetch(hView, phRecord)
; hView : MSIHANDLE -> "int"
; phRecord : MSIHANDLE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MsiViewFetch(MSIHANDLE hView, MSIHANDLE* phRecord)
#uselib "msi.dll"
#cfunc global MsiViewFetch "MsiViewFetch" int, var
; res = MsiViewFetch(hView, phRecord)
; hView : MSIHANDLE -> "int"
; phRecord : MSIHANDLE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiViewFetch = msi.NewProc("MsiViewFetch")
)

// hView (MSIHANDLE), phRecord (MSIHANDLE* in/out)
r1, _, err := procMsiViewFetch.Call(
	uintptr(hView),
	uintptr(phRecord),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiViewFetch(
  hView: DWORD;   // MSIHANDLE
  phRecord: Pointer   // MSIHANDLE* in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiViewFetch';
result := DllCall("msi\MsiViewFetch"
    , "UInt", hView   ; MSIHANDLE
    , "Ptr", phRecord   ; MSIHANDLE* in/out
    , "UInt")   ; return: DWORD
●MsiViewFetch(hView, phRecord) = DLL("msi.dll", "dword MsiViewFetch(dword, void*)")
# 呼び出し: MsiViewFetch(hView, phRecord)
# hView : MSIHANDLE -> "dword"
# phRecord : MSIHANDLE* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiViewFetch(
    hView: u32, // MSIHANDLE
    phRecord: [*c]u32 // MSIHANDLE* in/out
) callconv(std.os.windows.WINAPI) u32;
proc MsiViewFetch(
    hView: uint32,  # MSIHANDLE
    phRecord: ptr uint32  # MSIHANDLE* in/out
): uint32 {.importc: "MsiViewFetch", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiViewFetch(
    uint hView,   // MSIHANDLE
    uint* phRecord   // MSIHANDLE* in/out
);
ccall((:MsiViewFetch, "msi.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt32}),
      hView, phRecord)
# hView : MSIHANDLE -> UInt32
# phRecord : MSIHANDLE* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiViewFetch(
    uint32_t hView,
    uint32_t* phRecord);
]]
local msi = ffi.load("msi")
-- msi.MsiViewFetch(hView, phRecord)
-- hView : MSIHANDLE
-- phRecord : MSIHANDLE* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiViewFetch = lib.func('__stdcall', 'MsiViewFetch', 'uint32_t', ['uint32_t', 'uint32_t *']);
// MsiViewFetch(hView, phRecord)
// hView : MSIHANDLE -> 'uint32_t'
// phRecord : MSIHANDLE* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiViewFetch: { parameters: ["u32", "pointer"], result: "u32" },
});
// lib.symbols.MsiViewFetch(hView, phRecord)
// hView : MSIHANDLE -> "u32"
// phRecord : MSIHANDLE* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiViewFetch(
    uint32_t hView,
    uint32_t* phRecord);
C, "msi.dll");
// $ffi->MsiViewFetch(hView, phRecord);
// hView : MSIHANDLE
// phRecord : MSIHANDLE* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class);
    int MsiViewFetch(
        int hView,   // MSIHANDLE
        IntByReference phRecord   // MSIHANDLE* in/out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiViewFetch = MsiViewFetch(
    hView : UInt32,   # MSIHANDLE
    phRecord : UInt32*   # MSIHANDLE* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiViewFetchNative = Uint32 Function(Uint32, Pointer<Uint32>);
typedef MsiViewFetchDart = int Function(int, Pointer<Uint32>);
final MsiViewFetch = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiViewFetchNative, MsiViewFetchDart>('MsiViewFetch');
// hView : MSIHANDLE -> Uint32
// phRecord : MSIHANDLE* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiViewFetch(
  hView: DWORD;   // MSIHANDLE
  phRecord: Pointer   // MSIHANDLE* in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiViewFetch';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiViewFetch"
  c_MsiViewFetch :: Word32 -> Ptr Word32 -> IO Word32
-- hView : MSIHANDLE -> Word32
-- phRecord : MSIHANDLE* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiviewfetch =
  foreign "MsiViewFetch"
    (uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* hView : MSIHANDLE -> uint32_t *)
(* phRecord : MSIHANDLE* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiViewFetch" msi-view-fetch :convention :stdcall) :uint32
  (h-view :uint32)   ; MSIHANDLE
  (ph-record :pointer))   ; MSIHANDLE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiViewFetch = Win32::API::More->new('msi',
    'DWORD MsiViewFetch(DWORD hView, LPVOID phRecord)');
# my $ret = $MsiViewFetch->Call($hView, $phRecord);
# hView : MSIHANDLE -> DWORD
# phRecord : MSIHANDLE* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。