ホーム › System.ApplicationInstallationAndServicing › MsiViewGetErrorA

MsiViewGetErrorA

関数

ビュー操作で発生した検証エラーと該当カラム名を取得する。

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

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

MSIDBERROR MsiViewGetErrorA(
    MSIHANDLE hView,
    LPSTR szColumnNameBuffer,   // optional
    DWORD* pcchBuf   // optional
);

パラメーター

名前	型	方向	説明
hView	MSIHANDLE	in	ビューへのハンドル。
szColumnNameBuffer	LPSTR	outoptional	null 終端された列名を受け取るバッファーへのポインター。szColumnName に null (値 = 0) を渡してバッファーのサイズを判別しようとしてはいけません。バッファーのサイズを取得するには、空の文字列 (例えば "") を渡します。その場合、関数は MSIDBERROR_MOREDATA を返し、pcchBuf には終端の null 文字を含まない、必要なバッファーサイズが TCHAR 単位で格納されます。MSIDBERROR_NOERROR が返された場合、pcchBuf には終端の null 文字を含まない、バッファーに書き込まれた TCHAR 数が格納されます。エラーがない場合、このパラメーターは空の文字列になります。
pcchBuf	DWORD*	inoutoptional	szColumnNameBuffer 変数が指すバッファーのサイズを TCHAR 単位で指定する変数へのポインター。関数が MSIDBERROR_NOERROR を返すと、この変数には終端の null 文字を含まない、szColumnNameBuffer にコピーされたデータのサイズが格納されます。szColumnNameBuffer が十分な大きさでない場合、関数は MSIDBERROR_MOREDATA を返し、終端の null 文字を含まない、必要なサイズを pcchBuf が指す変数に格納します。

戻り値の型: MSIDBERROR

公式ドキュメント

MsiViewGetError 関数は、MsiViewModify 関数で発生したエラーを返します。(ANSI)

戻り値

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

エラーコード	意味
MSIDBERROR_INVALIDARG	引数が無効でした。
MSIDBERROR_MOREDATA	バッファーが小さすぎてデータを受け取れませんでした。
MSIDBERROR_FUNCTIONERROR	関数が失敗しました。
MSIDBERROR_NOERROR	関数はエラーなく正常に完了しました。
MSIDBERROR_DUPLICATEKEY	新しいレコードが、テーブル内の既存レコードの主キーと重複しています。
MSIDBERROR_REQUIRED	null 値は許可されていません。または、削除しようとしている列が別の行から参照されています。
MSIDBERROR_BADLINK	外部テーブル内の対応するレコードが見つかりませんでした。
MSIDBERROR_OVERFLOW	データが、許可される最大値を超えています。
MSIDBERROR_UNDERFLOW	データが、許可される最小値を下回っています。
MSIDBERROR_NOTINSET	データが、セット内で許可される値のいずれにも該当しません。
MSIDBERROR_BADVERSION	無効なバージョン文字列が指定されました。
MSIDBERROR_BADCASE	大文字小文字が無効でした。すべて大文字、またはすべて小文字でなければなりません。
MSIDBERROR_BADGUID	無効な GUID が指定されました。
MSIDBERROR_BADWILDCARD	無効なワイルドカードファイル名が指定されたか、ワイルドカードの使用が無効でした。
MSIDBERROR_BADIDENTIFIER	無効な識別子が指定されました。
MSIDBERROR_BADLANGUAGE	無効な言語 ID が指定されました。
MSIDBERROR_BADFILENAME	無効なファイル名が指定されました。
MSIDBERROR_BADPATH	無効なパスが指定されました。
MSIDBERROR_BADCONDITION	無効な条件文が指定されました。
MSIDBERROR_BADFORMATTED	無効な書式文字列が指定されました。
MSIDBERROR_BADTEMPLATE	無効なテンプレート文字列が指定されました。
MSIDBERROR_BADDEFAULTDIR	Directory テーブルの DefaultDir 列に無効な文字列が指定されました。
MSIDBERROR_BADREGPATH	無効なレジストリパス文字列が指定されました。
MSIDBERROR_BADCUSTOMSOURCE	CustomAction テーブルの CustomSource 列に無効な文字列が指定されました。
MSIDBERROR_BADPROPERTY	無効なプロパティ文字列が指定されました。
MSIDBERROR_MISSINGDATA	_Validation テーブルに、列への参照がありません。
MSIDBERROR_BADCATEGORY	その列に対する _Validation テーブルの category 列が無効です。
MSIDBERROR_BADCABINET	無効なキャビネット名が指定されました。
MSIDBERROR_BADKEYTABLE	_Validation テーブルの Keytable 列で指定されたテーブルが見つからないか、読み込めませんでした。
MSIDBERROR_BADMAXMINVALUES	_Validation テーブルの MaxValue 列の値が、MinValue 列の値より小さくなっています。
MSIDBERROR_BADSHORTCUT	無効なショートカットターゲット名が指定されました。
MSIDBERROR_STRINGOVERFLOW	文字列が、列定義で指定された長さに対して長すぎます。
MSIDBERROR_BADLOCALIZEATTRIB	無効なローカライズ属性が指定されました。(主キーはローカライズできません。)

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

解説(Remarks)

MsiViewGetError 関数は、MsiViewModify が ERROR_INVALID_DATA を返し、データが無効であることを示している場合にのみ呼び出してください。エラーは、MSIMODIFY_VALIDATE、MSIMODIFY_VALIDATE_NEW、および MSIMODIFY_VALIDATEFIELD に対してのみ記録されます。

ERROR_MORE_DATA が返された場合、ポインターであるパラメーターが、文字列を保持するために必要なバッファーのサイズを示します。成功時には、文字列バッファーに書き込まれた文字数を示します。したがって、小さなバッファー (最小で 1 文字) を渡し、関数が MSIDBERROR_MOREDATA を返したときに pcchPathBuf の値を調べることで、必要なバッファーサイズを取得できます。szColumnNameBuffer に null を渡したり、pcchBuf が参照する DWORD にバッファーサイズ 0 を渡したりして、バッファーのサイズを判別しようとしてはいけません。

MSIDBERROR_NOERROR が返されると、検証エラーは残っていません。MSIDBERROR の戻り値は、szColumnNameBuffer で識別される列にある値で発生した検証エラーの種類を示します。

メモ

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

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

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

MSIDBERROR MsiViewGetErrorA(
    MSIHANDLE hView,
    LPSTR szColumnNameBuffer,   // optional
    DWORD* pcchBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int MsiViewGetErrorA(
    uint hView,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szColumnNameBuffer,   // LPSTR optional, out
    IntPtr pcchBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiViewGetErrorA(
    hView As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPStr)> szColumnNameBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchBuf As IntPtr   ' DWORD* optional, in/out
) As Integer
End Function

' hView : MSIHANDLE
' szColumnNameBuffer : LPSTR optional, out
' pcchBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiViewGetErrorA Lib "msi" ( _
    ByVal hView As Long, _
    ByVal szColumnNameBuffer As String, _
    ByVal pcchBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiViewGetErrorA = ctypes.windll.msi.MsiViewGetErrorA
MsiViewGetErrorA.restype = ctypes.c_int
MsiViewGetErrorA.argtypes = [
    wintypes.DWORD,  # hView : MSIHANDLE
    wintypes.LPSTR,  # szColumnNameBuffer : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiViewGetErrorA = Fiddle::Function.new(
  lib['MsiViewGetErrorA'],
  [
    -Fiddle::TYPE_INT,  # hView : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szColumnNameBuffer : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBuf : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiViewGetErrorA(
        hView: u32,  // MSIHANDLE
        szColumnNameBuffer: *mut u8,  // LPSTR optional, out
        pcchBuf: *mut u32  // DWORD* optional, in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern int MsiViewGetErrorA(uint hView, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szColumnNameBuffer, IntPtr pcchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiViewGetErrorA' -Namespace Win32 -PassThru
# $api::MsiViewGetErrorA(hView, szColumnNameBuffer, pcchBuf)

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

出力引数:

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