📄 msiquery.h
字号:
/*****************************************************************************\
* *
* MsiQuery.h - Interface to running installer for custom actions and tools *
* *
* Version 1.0 *
* *
* NOTES: All buffers sizes are TCHAR count, null included only on input *
* Return argument pointers may be null if not interested in value *
* Returned handles of all types must be closed: MsiCloseHandle(h) *
* Functions with UINT return type return a system error code *
* Designated functions will set or clear the last error record, *
* which is then accessible with MsiGetLastErrorRecord. However, *
* the following argument errors do not register an error record: *
* ERROR_INVALID_HANDLE, ERROR_INVALID_PARAMETER, ERROR_MORE_DATA. *
* *
* Copyright (c) 1999, Microsoft Corp. All rights reserved. *
* *
\*****************************************************************************/
#ifndef _MSIQUERY_H_
#pragma option push -b -a8 -pc -A- /*P_O_Push*/
#define _MSIQUERY_H_
#include "msi.h" // INSTALLSTATE
#define MSI_NULL_INTEGER 0x80000000 // integer value reserved for null
// MsiOpenDatabase persist predefine values, otherwise output database path is used
#define MSIDBOPEN_READONLY (LPCTSTR)0 // database open read-only, no persistent changes
#define MSIDBOPEN_TRANSACT (LPCTSTR)1 // database read/write in transaction mode
#define MSIDBOPEN_DIRECT (LPCTSTR)2 // database direct read/write without transaction
#define MSIDBOPEN_CREATE (LPCTSTR)3 // create new database, transact mode read/write
#define MSIDBOPEN_CREATEDIRECT (LPCTSTR)4 // create new database, direct mode read/write
#define MSIDBOPEN_PATCHFILE 32/sizeof(*MSIDBOPEN_READONLY) // add flag to indicate patch file
typedef enum tagMSIDBSTATE
{
MSIDBSTATE_ERROR =-1, // invalid database handle
MSIDBSTATE_READ = 0, // database open read-only, no persistent changes
MSIDBSTATE_WRITE = 1, // database readable and updatable
} MSIDBSTATE;
typedef enum tagMSIMODIFY
{
MSIMODIFY_SEEK =-1, // reposition to current record primary key
MSIMODIFY_REFRESH = 0, // refetch current record data
MSIMODIFY_INSERT = 1, // insert new record, fails if matching key exists
MSIMODIFY_UPDATE = 2, // update existing non-key data of fetched record
MSIMODIFY_ASSIGN = 3, // insert record, replacing any existing record
MSIMODIFY_REPLACE = 4, // update record, delete old if primary key edit
MSIMODIFY_MERGE = 5, // fails if record with duplicate key not identical
MSIMODIFY_DELETE = 6, // remove row referenced by this record from table
MSIMODIFY_INSERT_TEMPORARY = 7, // insert a temporary record
MSIMODIFY_VALIDATE = 8, // validate a fetched record
MSIMODIFY_VALIDATE_NEW = 9, // validate a new record
MSIMODIFY_VALIDATE_FIELD = 10, // validate field(s) of an incomplete record
MSIMODIFY_VALIDATE_DELETE = 11, // validate before deleting record
} MSIMODIFY;
typedef enum tagMSICOLINFO
{
MSICOLINFO_NAMES = 0, // return column names
MSICOLINFO_TYPES = 1, // return column definitions, datatype code followed by width
} MSICOLINFO;
typedef enum tagMSICONDITION
{
MSICONDITION_FALSE = 0, // expression evaluates to False
MSICONDITION_TRUE = 1, // expression evaluates to True
MSICONDITION_NONE = 2, // no expression present
MSICONDITION_ERROR = 3, // syntax error in expression
} MSICONDITION;
typedef enum tagMSICOSTTREE
{
MSICOSTTREE_SELFONLY = 0,
MSICOSTTREE_CHILDREN = 1,
MSICOSTTREE_PARENTS = 2,
MSICOSTTREE_RESERVED = 3, // Reserved for future use
} MSICOSTTREE;
typedef enum tagMSIDBERROR
{
MSIDBERROR_INVALIDARG = -3, // invalid argument
MSIDBERROR_MOREDATA = -2, // buffer too small
MSIDBERROR_FUNCTIONERROR = -1, // function error
MSIDBERROR_NOERROR = 0, // no error
MSIDBERROR_DUPLICATEKEY = 1, // new record duplicates primary keys of existing record in table
MSIDBERROR_REQUIRED = 2, // non-nullable column, no null values allowed
MSIDBERROR_BADLINK = 3, // corresponding record in foreign table not found
MSIDBERROR_OVERFLOW = 4, // data greater than maximum value allowed
MSIDBERROR_UNDERFLOW = 5, // data less than minimum value allowed
MSIDBERROR_NOTINSET = 6, // data not a member of the values permitted in the set
MSIDBERROR_BADVERSION = 7, // invalid version string
MSIDBERROR_BADCASE = 8, // invalid case, must be all upper-case or all lower-case
MSIDBERROR_BADGUID = 9, // invalid GUID
MSIDBERROR_BADWILDCARD = 10, // invalid wildcardfilename or use of wildcards
MSIDBERROR_BADIDENTIFIER = 11, // bad identifier
MSIDBERROR_BADLANGUAGE = 12, // bad language Id(s)
MSIDBERROR_BADFILENAME = 13, // bad filename
MSIDBERROR_BADPATH = 14, // bad path
MSIDBERROR_BADCONDITION = 15, // bad conditional statement
MSIDBERROR_BADFORMATTED = 16, // bad format string
MSIDBERROR_BADTEMPLATE = 17, // bad template string
MSIDBERROR_BADDEFAULTDIR = 18, // bad string in DefaultDir column of Directory table
MSIDBERROR_BADREGPATH = 19, // bad registry path string
MSIDBERROR_BADCUSTOMSOURCE = 20, // bad string in CustomSource column of CustomAction table
MSIDBERROR_BADPROPERTY = 21, // bad property string
MSIDBERROR_MISSINGDATA = 22, // _Validation table missing reference to column
MSIDBERROR_BADCATEGORY = 23, // Category column of _Validation table for column is invalid
MSIDBERROR_BADKEYTABLE = 24, // table in KeyTable column of _Validation table could not be found/loaded
MSIDBERROR_BADMAXMINVALUES = 25, // value in MaxValue column of _Validation table is less than value in MinValue column
MSIDBERROR_BADCABINET = 26, // bad cabinet name
MSIDBERROR_BADSHORTCUT = 27, // bad shortcut target
MSIDBERROR_STRINGOVERFLOW = 28, // string overflow (greater than length allowed in column def)
MSIDBERROR_BADLOCALIZEATTRIB = 29 // invalid localization attribute (primary keys cannot be localized)
} MSIDBERROR;
typedef enum tagMSIRUNMODE
{
MSIRUNMODE_ADMIN = 0, // admin mode install, else product install
MSIRUNMODE_ADVERTISE = 1, // installing advertisements, else installing or updating product
MSIRUNMODE_MAINTENANCE = 2, // modifying an existing installation, else new installation
MSIRUNMODE_ROLLBACKENABLED = 3, // rollback is enabled
MSIRUNMODE_LOGENABLED = 4, // log file active, enabled prior to install session
MSIRUNMODE_OPERATIONS = 5, // spooling execute operations, else in determination phase
MSIRUNMODE_REBOOTATEND = 6, // reboot needed after successful installation (settable)
MSIRUNMODE_REBOOTNOW = 7, // reboot needed to continue installation (settable)
MSIRUNMODE_CABINET = 8, // installing files from cabinets and files using Media table
MSIRUNMODE_SOURCESHORTNAMES= 9, // source LongFileNames suppressed via PID_MSISOURCE summary property
MSIRUNMODE_TARGETSHORTNAMES= 10, // target LongFileNames suppressed via SHORTFILENAMES property
MSIRUNMODE_RESERVED11 = 11, // future use
MSIRUNMODE_WINDOWS9X = 12, // operating systems is Windows9?, else Windows NT
MSIRUNMODE_ZAWENABLED = 13, // operating system supports demand installation
MSIRUNMODE_RESERVED14 = 14, // future use
MSIRUNMODE_RESERVED15 = 15, // future use
MSIRUNMODE_SCHEDULED = 16, // custom action call from install script execution
MSIRUNMODE_ROLLBACK = 17, // custom action call from rollback execution script
MSIRUNMODE_COMMIT = 18, // custom action call from commit execution script
} MSIRUNMODE;
#define INSTALLMESSAGE_TYPEMASK = 0xFF000000L // mask for type code
// Note: INSTALLMESSAGE_ERROR, INSTALLMESSAGE_WARNING, INSTALLMESSAGE_USER are to or'd
// with a message box style to indicate the buttons to display and return:
// MB_OK,MB_OKCANCEL,MB_ABORTRETRYIGNORE,MB_YESNOCANCEL,MB_YESNO,MB_RETRYCANCEL
// the default button (MB_DEFBUTTON1 is normal default):
// MB_DEFBUTTON1, MB_DEFBUTTON2, MB_DEFBUTTON3
// and optionally an icon style:
// MB_ICONERROR, MB_ICONQUESTION, MB_ICONWARNING, MB_ICONINFORMATION
typedef enum tagMSITRANSFORM_ERROR
{
MSITRANSFORM_ERROR_ADDEXISTINGROW = 0x00000001,
MSITRANSFORM_ERROR_DELMISSINGROW = 0x00000002,
MSITRANSFORM_ERROR_ADDEXISTINGTABLE = 0x00000004,
MSITRANSFORM_ERROR_DELMISSINGTABLE = 0x00000008,
MSITRANSFORM_ERROR_UPDATEMISSINGROW = 0x00000010,
MSITRANSFORM_ERROR_CHANGECODEPAGE = 0x00000020,
MSITRANSFORM_ERROR_VIEWTRANSFORM = 0x00000100,
} MSITRANSFORM_ERROR;
typedef enum tagMSITRANSFORM_VALIDATE
{
MSITRANSFORM_VALIDATE_LANGUAGE = 0x00000001,
MSITRANSFORM_VALIDATE_PRODUCT = 0x00000002,
MSITRANSFORM_VALIDATE_PLATFORM = 0x00000004,
MSITRANSFORM_VALIDATE_MAJORVERSION = 0x00000008,
MSITRANSFORM_VALIDATE_MINORVERSION = 0x00000010,
MSITRANSFORM_VALIDATE_UPDATEVERSION = 0x00000020,
MSITRANSFORM_VALIDATE_NEWLESSBASEVERSION = 0x00000040,
MSITRANSFORM_VALIDATE_NEWLESSEQUALBASEVERSION = 0x00000080,
MSITRANSFORM_VALIDATE_NEWEQUALBASEVERSION = 0x00000100,
MSITRANSFORM_VALIDATE_NEWGREATEREQUALBASEVERSION = 0x00000200,
MSITRANSFORM_VALIDATE_NEWGREATERBASEVERSION = 0x00000400,
MSITRANSFORM_VALIDATE_UPGRADECODE = 0x00000800,
} MSITRANSFORM_VALIDATE;
#ifdef __cplusplus
extern "C" {
#endif
// --------------------------------------------------------------------------
// Installer database access functions
// --------------------------------------------------------------------------
// Prepare a database query, creating a view object
// Returns ERROR_SUCCESS if successful, and the view handle is returned,
// else ERROR_INVALID_HANDLE, ERROR_INVALID_HANDLE_STATE, ERROR_BAD_QUERY_SYNTAX, ERROR_GEN_FAILURE
// Execution of this function sets the error record, accessible via MsiGetLastErrorRecord
UINT WINAPI MsiDatabaseOpenViewA(MSIHANDLE hDatabase,
LPCSTR szQuery, // SQL query to be prepared
MSIHANDLE* phView); // returned view if TRUE
UINT WINAPI MsiDatabaseOpenViewW(MSIHANDLE hDatabase,
LPCWSTR szQuery, // SQL query to be prepared
MSIHANDLE* phView); // returned view if TRUE
#ifdef UNICODE
#define MsiDatabaseOpenView MsiDatabaseOpenViewW
#else
#define MsiDatabaseOpenView MsiDatabaseOpenViewA
#endif // !UNICODE
// Returns the MSIDBERROR enum and name of the column corresponding to the error
// Similar to a GetLastError function, but for the view. NOT the same as MsiGetLastErrorRecord
// Returns errors of MsiViewModify.
MSIDBERROR WINAPI MsiViewGetErrorA(MSIHANDLE hView,
LPSTR szColumnNameBuffer, // buffer to hold column name
DWORD* pcchBuf); // size of buffer
MSIDBERROR WINAPI MsiViewGetErrorW(MSIHANDLE hView,
LPWSTR szColumnNameBuffer, // buffer to hold column name
DWORD* pcchBuf); // size of buffer
#ifdef UNICODE
#define MsiViewGetError MsiViewGetErrorW
#else
#define MsiViewGetError MsiViewGetErrorA
#endif // !UNICODE
// Exectute the view query, supplying parameters as required
// Returns ERROR_SUCCESS, ERROR_INVALID_HANDLE, ERROR_INVALID_HANDLE_STATE, ERROR_GEN_FAILURE
// Execution of this function sets the error record, accessible via MsiGetLastErrorRecord
UINT WINAPI MsiViewExecute(MSIHANDLE hView,
MSIHANDLE hRecord); // optional parameter record, or 0 if none
// Fetch the next sequential record from the view
// Result is ERROR_SUCCESS if a row is found, and its handle is returned
// else ERROR_NO_DATA if no records remain, and a null handle is returned
// else result is error: ERROR_INVALID_HANDLE_STATE, ERROR_INVALID_HANDLE, ERROR_GEN_FAILURE
UINT WINAPI MsiViewFetch(MSIHANDLE hView,
MSIHANDLE *phRecord); // returned data record if fetch succeeds
// Modify a database record, parameters must match types in query columns
// Returns ERROR_SUCCESS, ERROR_INVALID_HANDLE, ERROR_INVALID_HANDLE_STATE, ERROR_GEN_FAILURE, ERROR_ACCESS_DENIED
// Execution of this function sets the error record, accessible via MsiGetLastErrorRecord
UINT WINAPI MsiViewModify(MSIHANDLE hView,
MSIMODIFY eModifyMode, // modify action to perform
MSIHANDLE hRecord); // record obtained from fetch, or new record
// Return the column names or specifications for the current view
// Returns ERROR_SUCCESS, ERROR_INVALID_HANDLE, ERROR_INVALID_PARAMETER, or ERROR_INVALID_HANDLE_STATE
UINT WINAPI MsiViewGetColumnInfo(MSIHANDLE hView,
MSICOLINFO eColumnInfo, // retrieve columns names or definitions
MSIHANDLE *phRecord); // returned data record containing all names or definitions
// Release the result set for an executed view, to allow re-execution
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -