diff --git a/APP-Test1.pro b/APP-Test1.pro index 27b307b..a3a4905 100644 --- a/APP-Test1.pro +++ b/APP-Test1.pro @@ -9,19 +9,26 @@ CONFIG += c++17 #DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0 SOURCES += \ + form_seting.cpp \ + form_usb.cpp \ main.cpp \ mainwindow.cpp \ - usb.cpp + usb_interface.cpp HEADERS += \ + form_seting.h \ + form_usb.h \ libusb.h \ mainwindow.h \ - usb.h + setupapi-x64/SETUPAPI.H \ + usb_interface.h FORMS += \ + form_seting.ui \ + form_usb.ui \ mainwindow.ui -LIBS += -L$$PWD/./ -lusb-1.0 +LIBS += -L$$PWD/./setupapi-x64/ -lsetupapi # Default rules for deployment. qnx: target.path = /tmp/$${TARGET}/bin diff --git a/APP-Test1.pro.user b/APP-Test1.pro.user new file mode 100644 index 0000000..bb2faa8 --- /dev/null +++ b/APP-Test1.pro.user @@ -0,0 +1,351 @@ + + + + + + EnvironmentId + {365fcea5-97bf-4386-8d9b-1f8d69787ebd} + + + ProjectExplorer.Project.ActiveTarget + 0 + + + ProjectExplorer.Project.EditorSettings + + true + false + true + + Cpp + + CppGlobal + + + + QmlJS + + QmlJSGlobal + + + 2 + UTF-8 + false + 4 + false + 0 + 80 + true + true + 1 + 0 + false + true + false + 2 + true + true + 0 + 8 + true + false + 1 + true + true + true + *.md, *.MD, Makefile + false + true + true + + + + ProjectExplorer.Project.PluginSettings + + + true + false + true + true + true + true + + false + + + 0 + true + + true + true + Builtin.DefaultTidyAndClazy + 11 + true + + + + true + + + + + ProjectExplorer.Project.Target.0 + + Desktop + Desktop Qt 6.8.2 MinGW 64-bit + Desktop Qt 6.8.2 MinGW 64-bit + qt.qt6.682.win64_mingw_kit + 0 + 0 + 0 + + 0 + D:\QT-APP\APP-Test1\build\Desktop_Qt_6_8_2_MinGW_64_bit-Debug + D:/QT-APP/APP-Test1/build/Desktop_Qt_6_8_2_MinGW_64_bit-Debug + + + true + QtProjectManager.QMakeBuildStep + false + + + + true + Qt4ProjectManager.MakeStep + + 2 + 构建 + 构建 + ProjectExplorer.BuildSteps.Build + + + + true + Qt4ProjectManager.MakeStep + clean + + 1 + 清除 + 清除 + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + Debug + Qt4ProjectManager.Qt4BuildConfiguration + 2 + + + D:\QT-APP\APP-Test1\build\Desktop_Qt_6_8_2_MinGW_64_bit-Release + D:/QT-APP/APP-Test1/build/Desktop_Qt_6_8_2_MinGW_64_bit-Release + + + true + QtProjectManager.QMakeBuildStep + false + + + + true + Qt4ProjectManager.MakeStep + + 2 + 构建 + 构建 + ProjectExplorer.BuildSteps.Build + + + + true + Qt4ProjectManager.MakeStep + clean + + 1 + 清除 + 清除 + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + Release + Qt4ProjectManager.Qt4BuildConfiguration + 0 + 0 + + + 0 + D:\QT-APP\APP-Test1\build\Desktop_Qt_6_8_2_MinGW_64_bit-Profile + D:/QT-APP/APP-Test1/build/Desktop_Qt_6_8_2_MinGW_64_bit-Profile + + + true + QtProjectManager.QMakeBuildStep + false + + + + true + Qt4ProjectManager.MakeStep + + 2 + 构建 + 构建 + ProjectExplorer.BuildSteps.Build + + + + true + Qt4ProjectManager.MakeStep + clean + + 1 + 清除 + 清除 + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + Profile + Qt4ProjectManager.Qt4BuildConfiguration + 0 + 0 + 0 + + + 0 + D:\QT-APP\APP-Test1\build\Desktop_Qt_6_8_2_MinGW_64_bit-Debug + D:/QT-APP/APP-Test1/build/Desktop_Qt_6_8_2_MinGW_64_bit-Debug + + + true + QtProjectManager.QMakeBuildStep + false + + + + true + Qt4ProjectManager.MakeStep + + 2 + 构建 + 构建 + ProjectExplorer.BuildSteps.Build + + + + true + Qt4ProjectManager.MakeStep + clean + + 1 + 清除 + 清除 + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + Debug2 + Qt4ProjectManager.Qt4BuildConfiguration + 2 + + + D:\QT-APP\APP-Test1\build\Desktop_Qt_6_8_2_MinGW_64_bit-Release + D:/QT-APP/APP-Test1/build/Desktop_Qt_6_8_2_MinGW_64_bit-Release + + + true + QtProjectManager.QMakeBuildStep + false + + + + true + Qt4ProjectManager.MakeStep + + 2 + 构建 + 构建 + ProjectExplorer.BuildSteps.Build + + + + true + Qt4ProjectManager.MakeStep + clean + + 1 + 清除 + 清除 + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + Release2 + Qt4ProjectManager.Qt4BuildConfiguration + 0 + 0 + + 5 + + + 0 + 部署 + 部署 + ProjectExplorer.BuildSteps.Deploy + + 1 + + false + ProjectExplorer.DefaultDeployConfiguration + + 1 + + true + true + 0 + true + + 2 + + false + -e cpu-cycles --call-graph "dwarf,4096" -F 250 + + Qt4ProjectManager.Qt4RunConfiguration: + D:/QT-APP/APP-Test1/APP-Test1.pro + false + true + true + true + D:/QT-APP/APP-Test1/build/Desktop_Qt_6_8_2_MinGW_64_bit-Debug + + 1 + + + + ProjectExplorer.Project.TargetCount + 1 + + + ProjectExplorer.Project.Updater.FileVersion + 22 + + + Version + 22 + + diff --git a/form_seting.cpp b/form_seting.cpp new file mode 100644 index 0000000..4e6a23e --- /dev/null +++ b/form_seting.cpp @@ -0,0 +1,14 @@ +#include "form_seting.h" +#include "ui_form_seting.h" + +Form_Seting::Form_Seting(QWidget *parent) + : QDialog(parent) + , ui(new Ui::Form_Seting) +{ + ui->setupUi(this); +} + +Form_Seting::~Form_Seting() +{ + delete ui; +} diff --git a/form_seting.h b/form_seting.h new file mode 100644 index 0000000..b67ffdb --- /dev/null +++ b/form_seting.h @@ -0,0 +1,22 @@ +#ifndef FORM_SETING_H +#define FORM_SETING_H + +#include + +namespace Ui { +class Form_Seting; +} + +class Form_Seting : public QDialog +{ + Q_OBJECT + +public: + explicit Form_Seting(QWidget *parent = nullptr); + ~Form_Seting(); + +private: + Ui::Form_Seting *ui; +}; + +#endif // FORM_SETING_H diff --git a/form_seting.ui b/form_seting.ui new file mode 100644 index 0000000..780673e --- /dev/null +++ b/form_seting.ui @@ -0,0 +1,223 @@ + + + Form_Seting + + + + 0 + 0 + 713 + 467 + + + + Seting + + + + + + + + 0 + + + + WIFI-蓝牙 + + + + + + + + WIFI + + + + + + + + SSID: + + + + + + + + + + PASSWORD: + + + + + + + + + + STA/AP: + + + + + + + + + + + + + + + 蓝牙 + + + + + + + + Name: + + + + + + + + + + Qt::Orientation::Horizontal + + + + 40 + 20 + + + + + + + + + + + + + + + Qt::Orientation::Horizontal + + + + 40 + 20 + + + + + + + + + 16 + + + + 设置 + + + + + + + + + + + + 本机 + + + + + + 本机信息 + + + + + + + + + + + + + Qt::Orientation::Vertical + + + + 20 + 40 + + + + + + + + + 24 + + + + 读取 + + + + + + + + + + + + + + + + + + + + + + + Qt::Orientation::Horizontal + + + + 40 + 20 + + + + + + + + + + + + + diff --git a/form_usb.cpp b/form_usb.cpp new file mode 100644 index 0000000..238cea6 --- /dev/null +++ b/form_usb.cpp @@ -0,0 +1,103 @@ +#include "form_usb.h" +#include "ui_form_usb.h" +#include +#include +#include +#include "form_seting.h" +#include "qmessagebox.h" + +Form_usb::Form_usb(QWidget *parent) + : QWidget(parent) + , ui(new Ui::Form_usb) +{ + ui->setupUi(this); + this->winId();//必须,不然nativeEvent不触发 + // myusb.hello(); + // QStringList devices = myusb.listUsbDevices(LIBUSB_CLASS_PRINTER); + // for (const QString &device : devices) { + // ui->textEdit->append(device); + // } + + connect(this, &Form_usb::usbDeviceChanged, this, &Form_usb::onUsbDeviceChanged); +} + +Form_usb::~Form_usb() +{ + delete ui; +} + +bool Form_usb::nativeEvent(const QByteArray &eventType, void *message, qintptr *result) { + Q_UNUSED(eventType) + Q_UNUSED(result) + + MSG *msg = static_cast(message); + if (msg->message == WM_DEVICECHANGE) { + if (msg->wParam == DBT_DEVICEARRIVAL) { + qDebug() << "USB Device Inserted!"; + ui->textEdit->append("USB Device Inserted!"); + emit usbDeviceChanged(true); // 发送信号 + } else if (msg->wParam == DBT_DEVICEREMOVECOMPLETE) { + qDebug() << "USB Device Removed!"; + ui->textEdit->append("USB Device Removed!"); + } + } + return QWidget::nativeEvent(eventType, message, result); +} + + +void Form_usb::on_pushButton_clicked() +{ + QMessageBox::information(this, "USB打印机", "连接成功"); + emit usbDeviceChanged(true); // 发送信号 +} + +void Form_usb::onUsbDeviceChanged(bool inserted) { + if (inserted) { + qDebug() << "USB Device Inserted!"; + } else { + qDebug() << "USB Device Removed!"; + } + QTimer::singleShot(5000, this, [this]() { + qDebug() << "2 秒后执行的任务"; + ui->textEdit->clear(); + ui->textEdit->append("USB Device Inserted!"); + + // if(myusb.ctx == nullptr) { + // ui->textEdit->append("myusb.ctx = nullptr"); + // } + // libusb_device_handle *handle = libusb_open_device_with_vid_pid(myusb.ctx, 0xfe6, 0x8800); + // if (handle == nullptr) { + // qDebug() << "Failed to open device!"; + // ui->textEdit->append("Failed to open USB device!"); + // }else{ + // ui->textEdit->append("Successfully to open USB device"); + // } + if(Printer_Usb.Usb_Open(0x0fe6,0x8800) == true) + { + const char data[] = "Hello, USB Printer!"; // 一个字符串数组 + DWORD dataSize = sizeof(data); // 获取数组大小 + ui->textEdit->append(Printer_Usb.DevicePath); + ui->textEdit->append("Successfully to open USB device"); + if(Printer_Usb.Usb_Data_Send(data,dataSize) == true) + { + ui->textEdit->append("Successfully to Usb_Data_Send"); + }else{ + ui->textEdit->append("Failed to Usb_Data_Send"); + } + Printer_Usb.Usb_Close(); + }else{ + ui->textEdit->append("Failed to open USB device!"); + } + + }); + +} + +void Form_usb::on_pushButton_2_clicked() +{ + Form_Seting settingWindow(this); + settingWindow.exec(); // 使用 exec(),阻塞主窗口 +} + + + diff --git a/form_usb.h b/form_usb.h new file mode 100644 index 0000000..56aa245 --- /dev/null +++ b/form_usb.h @@ -0,0 +1,37 @@ +#ifndef FORM_USB_H +#define FORM_USB_H + +#include +#include +#include +#include "usb_interface.h" +#include "form_seting.h" +namespace Ui { +class Form_usb; +} + +class Form_usb : public QWidget +{ + Q_OBJECT +public: + explicit Form_usb(QWidget *parent = nullptr); + ~Form_usb(); + +private: + Ui::Form_usb *ui; + Usb_Interface Printer_Usb; +protected: + bool nativeEvent(const QByteArray &eventType, void *message, qintptr *result) override; + +private slots: + void on_pushButton_clicked(); + void onUsbDeviceChanged(bool inserted); // 槽函数 + void on_pushButton_2_clicked(); + + void on_pushButton_windowTitleChanged(const QString &title); + +signals: + void usbDeviceChanged(bool inserted); // 声明信号 +}; + +#endif // FORM_USB_H diff --git a/form_usb.ui b/form_usb.ui new file mode 100644 index 0000000..204230b --- /dev/null +++ b/form_usb.ui @@ -0,0 +1,82 @@ + + + Form_usb + + + + 0 + 0 + 400 + 300 + + + + Form + + + + + + + + + + USB设备: + + + + + + + + + + 连接测试 + + + + + + + + + + + + + + + + + 18 + + + + 设置 + + + + + + + Qt::Orientation::Vertical + + + + 20 + 40 + + + + + + + + + + + + + + + diff --git a/main.cpp b/main.cpp index 115a22b..caffae3 100644 --- a/main.cpp +++ b/main.cpp @@ -1,10 +1,21 @@ #include "mainwindow.h" #include +#include "form_usb.h" +#include "form_seting.h" int main(int argc, char *argv[]) { QApplication a(argc, argv); - MainWindow w; - w.show(); + // MainWindow w; + // w.show(); + + Form_usb L; + L.show(); + + // Form_Seting S; + // S.show(); + // Form_usb *usbWindow = new Form_usb(nullptr); // 设置 parent=nullptr + // usbWindow->show(); + return a.exec(); } diff --git a/mainwindow.cpp b/mainwindow.cpp index 6264198..eba6329 100644 --- a/mainwindow.cpp +++ b/mainwindow.cpp @@ -11,7 +11,8 @@ #include #include #include "usb.h" - +#include +#include MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent) @@ -19,8 +20,6 @@ MainWindow::MainWindow(QWidget *parent) { ui->setupUi(this); - myusb.hello(); - myusb.listUsbDevices(); // 创建 QStandardItemModel(表格数据模型) QStandardItemModel *model = new QStandardItemModel(3, 2); @@ -108,19 +107,20 @@ void MainWindow::on_pushButton_clicked() void MainWindow::on_pushButton_2_clicked() { // 获取当前的模型 - QStandardItemModel *model = qobject_cast(ui->tableView->model()); + // QStandardItemModel *model = qobject_cast(ui->tableView->model()); - if (model) { - // 获取当前表格的行数 - int rowCount = model->rowCount(); + // if (model) { + // // 获取当前表格的行数 + // int rowCount = model->rowCount(); - // 插入新的一行 - model->insertRow(rowCount); + // // 插入新的一行 + // model->insertRow(rowCount); - // 为新行设置单元格内容 - model->setItem(rowCount, 0, new QStandardItem("")); // 第1列 - model->setItem(rowCount, 1, new QStandardItem("")); // 第2列 - } + // // 为新行设置单元格内容 + // model->setItem(rowCount, 0, new QStandardItem("")); // 第1列 + // model->setItem(rowCount, 1, new QStandardItem("")); // 第2列 + // } + ui->lineEdit->setText("000000"); } @@ -138,3 +138,22 @@ void MainWindow::on_pushButton_3_clicked() } } +bool MainWindow::nativeEvent(const QByteArray &eventType, void *message, qintptr *result) { + Q_UNUSED(eventType) + Q_UNUSED(result) + + MSG *msg = static_cast(message); + if (msg->message == WM_DEVICECHANGE) { + if (msg->wParam == DBT_DEVICEARRIVAL) { + qDebug() << "USB Device Inserted!"; + // ui->textEdit->append("USB Device Inserted!"); + ui->lineEdit->setText("USB Device Inserted!"); + } else if (msg->wParam == DBT_DEVICEREMOVECOMPLETE) { + qDebug() << "USB Device Removed!"; + // ui->textEdit->append("USB Device Removed!"); + ui->lineEdit->setText("USB Device Removed!"); + } + } + return QWidget::nativeEvent(eventType, message, result); +} + diff --git a/mainwindow.h b/mainwindow.h index 8f114de..dd14cad 100644 --- a/mainwindow.h +++ b/mainwindow.h @@ -2,7 +2,7 @@ #define MAINWINDOW_H #include -#include "usb.h" +#include QT_BEGIN_NAMESPACE namespace Ui { class MainWindow; @@ -26,6 +26,8 @@ private slots: private: Ui::MainWindow *ui; - usb myusb; // ✅ 在 MainWindow 类中定义 USB 对象 +protected: + virtual bool nativeEvent(const QByteArray &eventType, void *message, qintptr *result) override; + }; #endif // MAINWINDOW_H diff --git a/setupapi-x64/SETUPAPI.H b/setupapi-x64/SETUPAPI.H new file mode 100644 index 0000000..09e038f --- /dev/null +++ b/setupapi-x64/SETUPAPI.H @@ -0,0 +1,7531 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + setupapi.h + +Abstract: + + Public header file for Windows NT Setup and Device Installer services Dll. + +--*/ + +#ifndef _INC_SETUPAPI +#define _INC_SETUPAPI + +#if _MSC_VER > 1000 +#pragma once +#endif +#if defined (_MSC_VER) && (_MSC_VER >= 1200) +#pragma warning(push) +#pragma warning(disable:4201) /* nonstandard extension used : nameless struct/union */ +#endif + +// +// Define API decoration for direct importing of DLL references. +// +#if !defined(_SETUPAPI_) +#define WINSETUPAPI DECLSPEC_IMPORT +#else +#define WINSETUPAPI +#endif + +// +// determine version of setupapi based on _WIN32_WINDOWS and _WIN32_WINNT +// +// NT4 version of setupapi (_WIN32_WINNT_NT4) is earliest, and installed onto Win95 by IE. +// Win2k version of setupapi (_WIN32_WINNT_WIN2K) also shipped in WinME +// we'll use "0x0410" to indicate version of setupapi shipped with Win98 +// +#ifndef _SETUPAPI_VER +#if defined(_WIN32_WINNT) && (!defined(_WIN32_WINDOWS) || (_WIN32_WINNT < _WIN32_WINDOWS)) +#define _SETUPAPI_VER _WIN32_WINNT // SetupAPI version follows Windows NT version +#elif defined(_WIN32_WINDOWS) +#if _WIN32_WINDOWS >= 0x0490 +#define _SETUPAPI_VER _WIN32_WINNT_WIN2K // WinME uses same version of SetupAPI as Win2k +#elif _WIN32_WINDOWS >= 0x0410 +#define _SETUPAPI_VER 0x0410 // Indicates version of SetupAPI shipped with Win98 +#else +#define _SETUPAPI_VER _WIN32_WINNT_NT4 // Earliest SetupAPI version +#endif // _WIN32_WINDOWS +#else // _WIN32_WINNT/_WIN32_WINDOWS +#define _SETUPAPI_VER _WIN32_WINNT_WINXP +#endif // _WIN32_WINNT/_WIN32_WINDOWS +#endif // !_SETUPAPI_VER + +#ifndef __LPGUID_DEFINED__ +#define __LPGUID_DEFINED__ +typedef GUID *LPGUID; +#endif + +// +// Include spapidef.h for basic definitions and flags +// +#include + +// +// Include commctrl.h for our use of HIMAGELIST and wizard support. +// +#include + +// +// Include devpropdef.h for our use of DEVPROPERTYKEY and DEVPROPTYPE. +// +#include + +#ifdef _WIN64 +#include // Assume 8-byte (64-bit) packing throughout +#else +#include // Assume byte packing throughout (32-bit processor) +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Define maximum string length constants +// +#define LINE_LEN 256 // Windows 9x-compatible maximum for + // displayable strings coming from a + // device INF. +#define MAX_INF_STRING_LENGTH 4096 // Actual maximum size of an INF string + // (including string substitutions). +#define MAX_INF_SECTION_NAME_LENGTH 255 // For Windows 9x compatibility, INF + // section names should be constrained + // to 32 characters. + +#define MAX_TITLE_LEN 60 +#define MAX_INSTRUCTION_LEN 256 +#define MAX_LABEL_LEN 30 +#define MAX_SERVICE_NAME_LEN 256 +#define MAX_SUBTITLE_LEN 256 + +// +// Define maximum length of a machine name in the format expected by ConfigMgr32 +// CM_Connect_Machine (i.e., "\\\\MachineName\0"). +// +#define SP_MAX_MACHINENAME_LENGTH (MAX_PATH + 3) + +// +// Define type for reference to loaded inf file +// +typedef PVOID HINF; + +// +// Inf context structure. Applications must not interpret or +// overwrite values in these structures. +// +typedef struct _INFCONTEXT { + PVOID Inf; + PVOID CurrentInf; + UINT Section; + UINT Line; +} INFCONTEXT, *PINFCONTEXT; + +// +// Inf file information structure. +// +typedef struct _SP_INF_INFORMATION { + DWORD InfStyle; + DWORD InfCount; + BYTE VersionData[ANYSIZE_ARRAY]; +} SP_INF_INFORMATION, *PSP_INF_INFORMATION; + +// +// Define structure for passing alternate platform info into +// SetupSetFileQueueAlternatePlatform and SetupQueryInfOriginalFileInformation. +// +typedef struct _SP_ALTPLATFORM_INFO_V2 { + DWORD cbSize; + // + // platform to use (VER_PLATFORM_WIN32_WINDOWS or VER_PLATFORM_WIN32_NT) + // + DWORD Platform; + // + // major and minor version numbers to use + // + DWORD MajorVersion; + DWORD MinorVersion; + // + // processor architecture to use (PROCESSOR_ARCHITECTURE_INTEL, + // PROCESSOR_ARCHITECTURE_AMD64, or PROCESSOR_ARCHITECTURE_IA64. + // + WORD ProcessorArchitecture; + + union { + WORD Reserved; // for compatibility with V1 structure + WORD Flags; // indicates validity of non V1 fields + } DUMMYUNIONNAME; + + // + // specify SP_ALTPLATFORM_FLAGS_VERSION_RANGE in Flags + // to use FirstValidatedMajorVersion and FirstValidatedMinorVersion + // + // Major and minor versions of the oldest previous OS for which this + // package's digital signature may be considered valid. For example, say + // the alternate platform is VER_PLATFORM_WIN32_NT, version 5.1. However, + // it is wished that driver packages signed with a 5.0 osattr also be + // considered valid. In this case, you'd have a MajorVersion/MinorVersion + // of 5.1, and a FirstValidatedMajorVersion/FirstValidatedMinorVersion of + // 5.0. To validate packages signed for any previous OS release, specify + // 0 for these fields. To only validate against the target alternate + // platform, specify the same values as those in the MajorVersion and + // MinorVersion fields. + // + DWORD FirstValidatedMajorVersion; + DWORD FirstValidatedMinorVersion; + +} SP_ALTPLATFORM_INFO_V2, *PSP_ALTPLATFORM_INFO_V2; + +typedef struct _SP_ALTPLATFORM_INFO_V1 { + DWORD cbSize; + // + // platform to use (VER_PLATFORM_WIN32_WINDOWS or VER_PLATFORM_WIN32_NT) + // + DWORD Platform; + // + // major and minor version numbers to use + // + DWORD MajorVersion; + DWORD MinorVersion; + // + // processor architecture to use (PROCESSOR_ARCHITECTURE_INTEL, + // PROCESSOR_ARCHITECTURE_AMD64, or PROCESSOR_ARCHITECTURE_IA64. + // + WORD ProcessorArchitecture; + + WORD Reserved; // must be zero. +} SP_ALTPLATFORM_INFO_V1, *PSP_ALTPLATFORM_INFO_V1; + +#if USE_SP_ALTPLATFORM_INFO_V1 || (_SETUPAPI_VER < _WIN32_WINNT_WINXP) // use version 1 altplatform info data structure + +typedef SP_ALTPLATFORM_INFO_V1 SP_ALTPLATFORM_INFO; +typedef PSP_ALTPLATFORM_INFO_V1 PSP_ALTPLATFORM_INFO; + +#else // use version 2 altplatform info data structure + +typedef SP_ALTPLATFORM_INFO_V2 SP_ALTPLATFORM_INFO; +typedef PSP_ALTPLATFORM_INFO_V2 PSP_ALTPLATFORM_INFO; + +// +// the following flags are available to SP_ALTPLATFORM_INFO_V2 +// +#define SP_ALTPLATFORM_FLAGS_VERSION_RANGE (0x0001) // FirstValidatedMajor/MinorVersion + +#endif // use current version of altplatform info data structure + + +// +// Define structure that is filled in by SetupQueryInfOriginalFileInformation +// to indicate the INF's original name and the original name of the (potentially +// platform-specific) catalog file specified by that INF. +// +typedef struct _SP_ORIGINAL_FILE_INFO_A { + DWORD cbSize; + CHAR OriginalInfName[MAX_PATH]; + CHAR OriginalCatalogName[MAX_PATH]; +} SP_ORIGINAL_FILE_INFO_A, *PSP_ORIGINAL_FILE_INFO_A; + +typedef struct _SP_ORIGINAL_FILE_INFO_W { + DWORD cbSize; + WCHAR OriginalInfName[MAX_PATH]; + WCHAR OriginalCatalogName[MAX_PATH]; +} SP_ORIGINAL_FILE_INFO_W, *PSP_ORIGINAL_FILE_INFO_W; + +#ifdef UNICODE +typedef SP_ORIGINAL_FILE_INFO_W SP_ORIGINAL_FILE_INFO; +typedef PSP_ORIGINAL_FILE_INFO_W PSP_ORIGINAL_FILE_INFO; +#else +typedef SP_ORIGINAL_FILE_INFO_A SP_ORIGINAL_FILE_INFO; +typedef PSP_ORIGINAL_FILE_INFO_A PSP_ORIGINAL_FILE_INFO; +#endif + +// +// SP_INF_INFORMATION.InfStyle values +// +#define INF_STYLE_NONE 0x00000000 // unrecognized or non-existent +#define INF_STYLE_OLDNT 0x00000001 // winnt 3.x +#define INF_STYLE_WIN4 0x00000002 // Win95 + +// +// Additional InfStyle flags that may be specified when calling SetupOpenInfFile. +// +// +#define INF_STYLE_CACHE_ENABLE 0x00000010 // always cache INF, even outside of %windir%\Inf +#define INF_STYLE_CACHE_DISABLE 0x00000020 // delete cached INF information +#if _SETUPAPI_VER >= _WIN32_WINNT_WS03 +#define INF_STYLE_CACHE_IGNORE 0x00000040 // ignore any cached INF information +#endif + + +// +// Target directory specs. +// +#define DIRID_ABSOLUTE -1 // real 32-bit -1 +#define DIRID_ABSOLUTE_16BIT 0xffff // 16-bit -1 for compat w/setupx +#define DIRID_NULL 0 +#define DIRID_SRCPATH 1 +#define DIRID_WINDOWS 10 +#define DIRID_SYSTEM 11 // system32 +#define DIRID_DRIVERS 12 +#define DIRID_IOSUBSYS DIRID_DRIVERS +#define DIRID_INF 17 +#define DIRID_HELP 18 +#define DIRID_FONTS 20 +#define DIRID_VIEWERS 21 +#define DIRID_COLOR 23 +#define DIRID_APPS 24 +#define DIRID_SHARED 25 +#define DIRID_BOOT 30 + +#define DIRID_SYSTEM16 50 +#define DIRID_SPOOL 51 +#define DIRID_SPOOLDRIVERS 52 +#define DIRID_USERPROFILE 53 +#define DIRID_LOADER 54 +#define DIRID_PRINTPROCESSOR 55 + +#define DIRID_DEFAULT DIRID_SYSTEM + +// +// The following DIRIDs are for commonly-used shell "special folders". The +// complete list of such folders is contained in shlobj.h. In that headerfile, +// each folder is assigned a CSIDL_* value. The DIRID values below are created +// by taking the CSIDL value in shlobj.h and OR'ing it with 0x4000. Thus, if +// an INF needs to reference other special folders not defined below, it may +// generate one using the above mechanism, and setupapi will automatically deal +// with it and use the corresponding shell's path where appropriate. (Remember +// that DIRIDs must be specified in decimal, not hex, in an INF when used for +// string substitution.) +// +#define DIRID_COMMON_STARTMENU 16406 // All Users\Start Menu +#define DIRID_COMMON_PROGRAMS 16407 // All Users\Start Menu\Programs +#define DIRID_COMMON_STARTUP 16408 // All Users\Start Menu\Programs\Startup +#define DIRID_COMMON_DESKTOPDIRECTORY 16409 // All Users\Desktop +#define DIRID_COMMON_FAVORITES 16415 // All Users\Favorites +#define DIRID_COMMON_APPDATA 16419 // All Users\Application Data + +#define DIRID_PROGRAM_FILES 16422 // Program Files +#define DIRID_SYSTEM_X86 16425 // system32 for WOW +#define DIRID_PROGRAM_FILES_X86 16426 // Program Files for WOW +#define DIRID_PROGRAM_FILES_COMMON 16427 // Program Files\Common +#define DIRID_PROGRAM_FILES_COMMONX86 16428 // x86 Program Files\Common for WOW + +#define DIRID_COMMON_TEMPLATES 16429 // All Users\Templates +#define DIRID_COMMON_DOCUMENTS 16430 // All Users\Documents + + +// +// First user-definable dirid. See SetupSetDirectoryId(). +// +#define DIRID_USER 0x8000 + + +// +// Setup callback notification routine type +// +typedef UINT (CALLBACK* PSP_FILE_CALLBACK_A)( + IN PVOID Context, + IN UINT Notification, + IN UINT_PTR Param1, + IN UINT_PTR Param2 + ); + +typedef UINT (CALLBACK* PSP_FILE_CALLBACK_W)( + IN PVOID Context, + IN UINT Notification, + IN UINT_PTR Param1, + IN UINT_PTR Param2 + ); + +#ifdef UNICODE +#define PSP_FILE_CALLBACK PSP_FILE_CALLBACK_W +#else +#define PSP_FILE_CALLBACK PSP_FILE_CALLBACK_A +#endif + + +// +// Operation/queue start/end notification. These are ordinal values. +// +#define SPFILENOTIFY_STARTQUEUE 0x00000001 +#define SPFILENOTIFY_ENDQUEUE 0x00000002 +#define SPFILENOTIFY_STARTSUBQUEUE 0x00000003 +#define SPFILENOTIFY_ENDSUBQUEUE 0x00000004 +#define SPFILENOTIFY_STARTDELETE 0x00000005 +#define SPFILENOTIFY_ENDDELETE 0x00000006 +#define SPFILENOTIFY_DELETEERROR 0x00000007 +#define SPFILENOTIFY_STARTRENAME 0x00000008 +#define SPFILENOTIFY_ENDRENAME 0x00000009 +#define SPFILENOTIFY_RENAMEERROR 0x0000000a +#define SPFILENOTIFY_STARTCOPY 0x0000000b +#define SPFILENOTIFY_ENDCOPY 0x0000000c +#define SPFILENOTIFY_COPYERROR 0x0000000d +#define SPFILENOTIFY_NEEDMEDIA 0x0000000e +#define SPFILENOTIFY_QUEUESCAN 0x0000000f +// +// These are used with SetupIterateCabinet(). +// +#define SPFILENOTIFY_CABINETINFO 0x00000010 +#define SPFILENOTIFY_FILEINCABINET 0x00000011 +#define SPFILENOTIFY_NEEDNEWCABINET 0x00000012 +#define SPFILENOTIFY_FILEEXTRACTED 0x00000013 +#define SPFILENOTIFY_FILEOPDELAYED 0x00000014 +// +// These are used for backup operations +// +#define SPFILENOTIFY_STARTBACKUP 0x00000015 +#define SPFILENOTIFY_BACKUPERROR 0x00000016 +#define SPFILENOTIFY_ENDBACKUP 0x00000017 +// +// Extended notification for SetupScanFileQueue(Flags=SPQ_SCAN_USE_CALLBACKEX) +// +#define SPFILENOTIFY_QUEUESCAN_EX 0x00000018 + +#define SPFILENOTIFY_STARTREGISTRATION 0x00000019 +#define SPFILENOTIFY_ENDREGISTRATION 0x00000020 + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Extended notification for SetupScanFileQueue(Flags=SPQ_SCAN_USE_CALLBACK_SIGNERINFO) +// +#define SPFILENOTIFY_QUEUESCAN_SIGNERINFO 0x00000040 + +#endif + +// +// Copy notification. These are bit flags that may be combined. +// +#define SPFILENOTIFY_LANGMISMATCH 0x00010000 +#define SPFILENOTIFY_TARGETEXISTS 0x00020000 +#define SPFILENOTIFY_TARGETNEWER 0x00040000 + +// +// File operation codes and callback outcomes. +// +#define FILEOP_COPY 0 +#define FILEOP_RENAME 1 +#define FILEOP_DELETE 2 +#define FILEOP_BACKUP 3 + +#define FILEOP_ABORT 0 +#define FILEOP_DOIT 1 +#define FILEOP_SKIP 2 +#define FILEOP_RETRY FILEOP_DOIT +#define FILEOP_NEWPATH 4 + +// +// Flags in inf copy sections +// +#define COPYFLG_WARN_IF_SKIP 0x00000001 // warn if user tries to skip file +#define COPYFLG_NOSKIP 0x00000002 // disallow skipping this file +#define COPYFLG_NOVERSIONCHECK 0x00000004 // ignore versions and overwrite target +#define COPYFLG_FORCE_FILE_IN_USE 0x00000008 // force file-in-use behavior +#define COPYFLG_NO_OVERWRITE 0x00000010 // do not copy if file exists on target +#define COPYFLG_NO_VERSION_DIALOG 0x00000020 // do not copy if target is newer +#define COPYFLG_OVERWRITE_OLDER_ONLY 0x00000040 // leave target alone if version same as source +#define COPYFLG_PROTECTED_WINDOWS_DRIVER_FILE 0x00000100 // a Windows driver file to be + // protected as other Windows system files + +#define COPYFLG_REPLACEONLY 0x00000400 // copy only if file exists on target +#define COPYFLG_NODECOMP 0x00000800 // don't attempt to decompress file; copy as-is +#define COPYFLG_REPLACE_BOOT_FILE 0x00001000 // file must be present upon reboot (i.e., it's + // needed by the loader); this flag implies a reboot +#define COPYFLG_NOPRUNE 0x00002000 // never prune this file +#define COPYFLG_IN_USE_TRY_RENAME 0x00004000 // If file in use, try to rename the target first + +// +// Flags in inf delete sections +// New flags go in high word +// +#define DELFLG_IN_USE 0x00000001 // queue in-use file for delete +#define DELFLG_IN_USE1 0x00010000 // high-word version of DELFLG_IN_USE + +// +// Source and file paths. Used when notifying queue callback +// of SPFILENOTIFY_STARTxxx, SPFILENOTIFY_ENDxxx, and SPFILENOTIFY_xxxERROR. +// +typedef struct _FILEPATHS_A { + PCSTR Target; + PCSTR Source; // not used for delete operations + UINT Win32Error; + DWORD Flags; // such as SP_COPY_NOSKIP for copy errors +} FILEPATHS_A, *PFILEPATHS_A; + +typedef struct _FILEPATHS_W { + PCWSTR Target; + PCWSTR Source; // not used for delete operations + UINT Win32Error; + DWORD Flags; // such as SP_COPY_NOSKIP for copy errors +} FILEPATHS_W, *PFILEPATHS_W; + +#ifdef UNICODE +typedef FILEPATHS_W FILEPATHS; +typedef PFILEPATHS_W PFILEPATHS; +#else +typedef FILEPATHS_A FILEPATHS; +typedef PFILEPATHS_A PFILEPATHS; +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +typedef struct _FILEPATHS_SIGNERINFO_A { + PCSTR Target; + PCSTR Source; // not used for delete operations + UINT Win32Error; + DWORD Flags; // such as SP_COPY_NOSKIP for copy errors + PCSTR DigitalSigner; + PCSTR Version; + PCSTR CatalogFile; +} FILEPATHS_SIGNERINFO_A, *PFILEPATHS_SIGNERINFO_A; + +typedef struct _FILEPATHS_SIGNERINFO_W { + PCWSTR Target; + PCWSTR Source; // not used for delete operations + UINT Win32Error; + DWORD Flags; // such as SP_COPY_NOSKIP for copy errors + PCWSTR DigitalSigner; + PCWSTR Version; + PCWSTR CatalogFile; +} FILEPATHS_SIGNERINFO_W, *PFILEPATHS_SIGNERINFO_W; + +#ifdef UNICODE +typedef FILEPATHS_SIGNERINFO_W FILEPATHS_SIGNERINFO; +typedef PFILEPATHS_SIGNERINFO_W PFILEPATHS_SIGNERINFO; +#else +typedef FILEPATHS_SIGNERINFO_A FILEPATHS_SIGNERINFO; +typedef PFILEPATHS_SIGNERINFO_A PFILEPATHS_SIGNERINFO; +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Structure used with SPFILENOTIFY_NEEDMEDIA +// +typedef struct _SOURCE_MEDIA_A { + PCSTR Reserved; + PCSTR Tagfile; // may be NULL + PCSTR Description; + // + // Pathname part and filename part of source file + // that caused us to need the media. + // + PCSTR SourcePath; + PCSTR SourceFile; + DWORD Flags; // subset of SP_COPY_xxx +} SOURCE_MEDIA_A, *PSOURCE_MEDIA_A; + +typedef struct _SOURCE_MEDIA_W { + PCWSTR Reserved; + PCWSTR Tagfile; // may be NULL + PCWSTR Description; + // + // Pathname part and filename part of source file + // that caused us to need the media. + // + PCWSTR SourcePath; + PCWSTR SourceFile; + DWORD Flags; // subset of SP_COPY_xxx +} SOURCE_MEDIA_W, *PSOURCE_MEDIA_W; + +#ifdef UNICODE +typedef SOURCE_MEDIA_W SOURCE_MEDIA; +typedef PSOURCE_MEDIA_W PSOURCE_MEDIA; +#else +typedef SOURCE_MEDIA_A SOURCE_MEDIA; +typedef PSOURCE_MEDIA_A PSOURCE_MEDIA; +#endif + +// +// Structure used with SPFILENOTIFY_CABINETINFO and +// SPFILENOTIFY_NEEDNEWCABINET +// +typedef struct _CABINET_INFO_A { + PCSTR CabinetPath; + PCSTR CabinetFile; + PCSTR DiskName; + USHORT SetId; + USHORT CabinetNumber; +} CABINET_INFO_A, *PCABINET_INFO_A; + +typedef struct _CABINET_INFO_W { + PCWSTR CabinetPath; + PCWSTR CabinetFile; + PCWSTR DiskName; + USHORT SetId; + USHORT CabinetNumber; +} CABINET_INFO_W, *PCABINET_INFO_W; + +#ifdef UNICODE +typedef CABINET_INFO_W CABINET_INFO; +typedef PCABINET_INFO_W PCABINET_INFO; +#else +typedef CABINET_INFO_A CABINET_INFO; +typedef PCABINET_INFO_A PCABINET_INFO; +#endif + +// +// Structure used with SPFILENOTIFY_FILEINCABINET +// +typedef struct _FILE_IN_CABINET_INFO_A { + PCSTR NameInCabinet; + DWORD FileSize; + DWORD Win32Error; + WORD DosDate; + WORD DosTime; + WORD DosAttribs; + CHAR FullTargetName[MAX_PATH]; +} FILE_IN_CABINET_INFO_A, *PFILE_IN_CABINET_INFO_A; + +typedef struct _FILE_IN_CABINET_INFO_W { + PCWSTR NameInCabinet; + DWORD FileSize; + DWORD Win32Error; + WORD DosDate; + WORD DosTime; + WORD DosAttribs; + WCHAR FullTargetName[MAX_PATH]; +} FILE_IN_CABINET_INFO_W, *PFILE_IN_CABINET_INFO_W; + +#ifdef UNICODE +typedef FILE_IN_CABINET_INFO_W FILE_IN_CABINET_INFO; +typedef PFILE_IN_CABINET_INFO_W PFILE_IN_CABINET_INFO; +#else +typedef FILE_IN_CABINET_INFO_A FILE_IN_CABINET_INFO; +typedef PFILE_IN_CABINET_INFO_A PFILE_IN_CABINET_INFO; +#endif + +// +// Structure used for SPFILENOTIFY_***REGISTRATION +// callback +// + +typedef struct _SP_REGISTER_CONTROL_STATUSA { + DWORD cbSize; + PCSTR FileName; + DWORD Win32Error; + DWORD FailureCode; +} SP_REGISTER_CONTROL_STATUSA, *PSP_REGISTER_CONTROL_STATUSA; + +typedef struct _SP_REGISTER_CONTROL_STATUSW { + DWORD cbSize; + PCWSTR FileName; + DWORD Win32Error; + DWORD FailureCode; +} SP_REGISTER_CONTROL_STATUSW, *PSP_REGISTER_CONTROL_STATUSW; + +#ifdef UNICODE +typedef SP_REGISTER_CONTROL_STATUSW SP_REGISTER_CONTROL_STATUS; +typedef PSP_REGISTER_CONTROL_STATUSW PSP_REGISTER_CONTROL_STATUS; +#else +typedef SP_REGISTER_CONTROL_STATUSA SP_REGISTER_CONTROL_STATUS; +typedef PSP_REGISTER_CONTROL_STATUSA PSP_REGISTER_CONTROL_STATUS; +#endif + + +// +// valid values for SP_REGISTER_CONTROL_STATUS.FailureCode field +// + +#define SPREG_SUCCESS 0x00000000 +#define SPREG_LOADLIBRARY 0x00000001 +#define SPREG_GETPROCADDR 0x00000002 +#define SPREG_REGSVR 0x00000003 +#define SPREG_DLLINSTALL 0x00000004 +#define SPREG_TIMEOUT 0x00000005 +#define SPREG_UNKNOWN 0xFFFFFFFF + +// +// Define type for setup file queue +// +typedef PVOID HSPFILEQ; + +// +// Structure used with SetupQueueCopyIndirect +// +typedef struct _SP_FILE_COPY_PARAMS_A { + DWORD cbSize; + HSPFILEQ QueueHandle; + PCSTR SourceRootPath; OPTIONAL + PCSTR SourcePath; OPTIONAL + PCSTR SourceFilename; + PCSTR SourceDescription; OPTIONAL + PCSTR SourceTagfile; OPTIONAL + PCSTR TargetDirectory; + PCSTR TargetFilename; OPTIONAL + DWORD CopyStyle; + HINF LayoutInf; OPTIONAL + PCSTR SecurityDescriptor; OPTIONAL +} SP_FILE_COPY_PARAMS_A, *PSP_FILE_COPY_PARAMS_A; + +typedef struct _SP_FILE_COPY_PARAMS_W { + DWORD cbSize; + HSPFILEQ QueueHandle; + PCWSTR SourceRootPath; OPTIONAL + PCWSTR SourcePath; OPTIONAL + PCWSTR SourceFilename; + PCWSTR SourceDescription; OPTIONAL + PCWSTR SourceTagfile; OPTIONAL + PCWSTR TargetDirectory; + PCWSTR TargetFilename; OPTIONAL + DWORD CopyStyle; + HINF LayoutInf; OPTIONAL + PCWSTR SecurityDescriptor; OPTIONAL +} SP_FILE_COPY_PARAMS_W, *PSP_FILE_COPY_PARAMS_W; + +#ifdef UNICODE +typedef SP_FILE_COPY_PARAMS_W SP_FILE_COPY_PARAMS; +typedef PSP_FILE_COPY_PARAMS_W PSP_FILE_COPY_PARAMS; +#else +typedef SP_FILE_COPY_PARAMS_A SP_FILE_COPY_PARAMS; +typedef PSP_FILE_COPY_PARAMS_A PSP_FILE_COPY_PARAMS; +#endif + + +// +// Define type for setup disk space list +// +typedef PVOID HDSKSPC; + +// +// Define type for reference to device information set +// +typedef PVOID HDEVINFO; + +// +// Device information structure (references a device instance +// that is a member of a device information set) +// +typedef struct _SP_DEVINFO_DATA { + DWORD cbSize; + GUID ClassGuid; + DWORD DevInst; // DEVINST handle + ULONG_PTR Reserved; +} SP_DEVINFO_DATA, *PSP_DEVINFO_DATA; + +// +// Device interface information structure (references a device +// interface that is associated with the device information +// element that owns it). +// +typedef struct _SP_DEVICE_INTERFACE_DATA { + DWORD cbSize; + GUID InterfaceClassGuid; + DWORD Flags; + ULONG_PTR Reserved; +} SP_DEVICE_INTERFACE_DATA, *PSP_DEVICE_INTERFACE_DATA; + +// +// Flags for SP_DEVICE_INTERFACE_DATA.Flags field. +// +#define SPINT_ACTIVE 0x00000001 +#define SPINT_DEFAULT 0x00000002 +#define SPINT_REMOVED 0x00000004 + +// +// Backward compatibility--do not use. +// +typedef SP_DEVICE_INTERFACE_DATA SP_INTERFACE_DEVICE_DATA; +typedef PSP_DEVICE_INTERFACE_DATA PSP_INTERFACE_DEVICE_DATA; +#define SPID_ACTIVE SPINT_ACTIVE +#define SPID_DEFAULT SPINT_DEFAULT +#define SPID_REMOVED SPINT_REMOVED + + +typedef struct _SP_DEVICE_INTERFACE_DETAIL_DATA_A { + DWORD cbSize; + CHAR DevicePath[ANYSIZE_ARRAY]; +} SP_DEVICE_INTERFACE_DETAIL_DATA_A, *PSP_DEVICE_INTERFACE_DETAIL_DATA_A; + +typedef struct _SP_DEVICE_INTERFACE_DETAIL_DATA_W { + DWORD cbSize; + WCHAR DevicePath[ANYSIZE_ARRAY]; +} SP_DEVICE_INTERFACE_DETAIL_DATA_W, *PSP_DEVICE_INTERFACE_DETAIL_DATA_W; + +#ifdef UNICODE +typedef SP_DEVICE_INTERFACE_DETAIL_DATA_W SP_DEVICE_INTERFACE_DETAIL_DATA; +typedef PSP_DEVICE_INTERFACE_DETAIL_DATA_W PSP_DEVICE_INTERFACE_DETAIL_DATA; +#else +typedef SP_DEVICE_INTERFACE_DETAIL_DATA_A SP_DEVICE_INTERFACE_DETAIL_DATA; +typedef PSP_DEVICE_INTERFACE_DETAIL_DATA_A PSP_DEVICE_INTERFACE_DETAIL_DATA; +#endif + +// +// Backward compatibility--do not use. +// +typedef SP_DEVICE_INTERFACE_DETAIL_DATA_W SP_INTERFACE_DEVICE_DETAIL_DATA_W; +typedef PSP_DEVICE_INTERFACE_DETAIL_DATA_W PSP_INTERFACE_DEVICE_DETAIL_DATA_W; +typedef SP_DEVICE_INTERFACE_DETAIL_DATA_A SP_INTERFACE_DEVICE_DETAIL_DATA_A; +typedef PSP_DEVICE_INTERFACE_DETAIL_DATA_A PSP_INTERFACE_DEVICE_DETAIL_DATA_A; +#ifdef UNICODE +typedef SP_INTERFACE_DEVICE_DETAIL_DATA_W SP_INTERFACE_DEVICE_DETAIL_DATA; +typedef PSP_INTERFACE_DEVICE_DETAIL_DATA_W PSP_INTERFACE_DEVICE_DETAIL_DATA; +#else +typedef SP_INTERFACE_DEVICE_DETAIL_DATA_A SP_INTERFACE_DEVICE_DETAIL_DATA; +typedef PSP_INTERFACE_DEVICE_DETAIL_DATA_A PSP_INTERFACE_DEVICE_DETAIL_DATA; +#endif + + +// +// Structure for detailed information on a device information set (used for +// SetupDiGetDeviceInfoListDetail which supercedes the functionality of +// SetupDiGetDeviceInfoListClass). +// +typedef struct _SP_DEVINFO_LIST_DETAIL_DATA_A { + DWORD cbSize; + GUID ClassGuid; + HANDLE RemoteMachineHandle; + CHAR RemoteMachineName[SP_MAX_MACHINENAME_LENGTH]; +} SP_DEVINFO_LIST_DETAIL_DATA_A, *PSP_DEVINFO_LIST_DETAIL_DATA_A; + +typedef struct _SP_DEVINFO_LIST_DETAIL_DATA_W { + DWORD cbSize; + GUID ClassGuid; + HANDLE RemoteMachineHandle; + WCHAR RemoteMachineName[SP_MAX_MACHINENAME_LENGTH]; +} SP_DEVINFO_LIST_DETAIL_DATA_W, *PSP_DEVINFO_LIST_DETAIL_DATA_W; + +#ifdef UNICODE +typedef SP_DEVINFO_LIST_DETAIL_DATA_W SP_DEVINFO_LIST_DETAIL_DATA; +typedef PSP_DEVINFO_LIST_DETAIL_DATA_W PSP_DEVINFO_LIST_DETAIL_DATA; +#else +typedef SP_DEVINFO_LIST_DETAIL_DATA_A SP_DEVINFO_LIST_DETAIL_DATA; +typedef PSP_DEVINFO_LIST_DETAIL_DATA_A PSP_DEVINFO_LIST_DETAIL_DATA; +#endif + +// +// Class installer function codes +// +#define DIF_SELECTDEVICE 0x00000001 +#define DIF_INSTALLDEVICE 0x00000002 +#define DIF_ASSIGNRESOURCES 0x00000003 +#define DIF_PROPERTIES 0x00000004 +#define DIF_REMOVE 0x00000005 +#define DIF_FIRSTTIMESETUP 0x00000006 +#define DIF_FOUNDDEVICE 0x00000007 +#define DIF_SELECTCLASSDRIVERS 0x00000008 +#define DIF_VALIDATECLASSDRIVERS 0x00000009 +#define DIF_INSTALLCLASSDRIVERS 0x0000000A +#define DIF_CALCDISKSPACE 0x0000000B +#define DIF_DESTROYPRIVATEDATA 0x0000000C +#define DIF_VALIDATEDRIVER 0x0000000D +#define DIF_DETECT 0x0000000F +#define DIF_INSTALLWIZARD 0x00000010 +#define DIF_DESTROYWIZARDDATA 0x00000011 +#define DIF_PROPERTYCHANGE 0x00000012 +#define DIF_ENABLECLASS 0x00000013 +#define DIF_DETECTVERIFY 0x00000014 +#define DIF_INSTALLDEVICEFILES 0x00000015 +#define DIF_UNREMOVE 0x00000016 +#define DIF_SELECTBESTCOMPATDRV 0x00000017 +#define DIF_ALLOW_INSTALL 0x00000018 +#define DIF_REGISTERDEVICE 0x00000019 +#define DIF_NEWDEVICEWIZARD_PRESELECT 0x0000001A +#define DIF_NEWDEVICEWIZARD_SELECT 0x0000001B +#define DIF_NEWDEVICEWIZARD_PREANALYZE 0x0000001C +#define DIF_NEWDEVICEWIZARD_POSTANALYZE 0x0000001D +#define DIF_NEWDEVICEWIZARD_FINISHINSTALL 0x0000001E +#define DIF_UNUSED1 0x0000001F +#define DIF_INSTALLINTERFACES 0x00000020 +#define DIF_DETECTCANCEL 0x00000021 +#define DIF_REGISTER_COINSTALLERS 0x00000022 +#define DIF_ADDPROPERTYPAGE_ADVANCED 0x00000023 +#define DIF_ADDPROPERTYPAGE_BASIC 0x00000024 +#define DIF_RESERVED1 0x00000025 +#define DIF_TROUBLESHOOTER 0x00000026 +#define DIF_POWERMESSAGEWAKE 0x00000027 +#define DIF_ADDREMOTEPROPERTYPAGE_ADVANCED 0x00000028 +#define DIF_UPDATEDRIVER_UI 0x00000029 +#define DIF_FINISHINSTALL_ACTION 0x0000002A +#define DIF_RESERVED2 0x00000030 + +// +// Obsoleted DIF codes (do not use) +// +#define DIF_MOVEDEVICE 0x0000000E + + +typedef UINT DI_FUNCTION; // Function type for device installer + + +// +// Device installation parameters structure (associated with a +// particular device information element, or globally with a device +// information set) +// +typedef struct _SP_DEVINSTALL_PARAMS_A { + DWORD cbSize; + DWORD Flags; + DWORD FlagsEx; + HWND hwndParent; + PSP_FILE_CALLBACK InstallMsgHandler; + PVOID InstallMsgHandlerContext; + HSPFILEQ FileQueue; + ULONG_PTR ClassInstallReserved; + DWORD Reserved; + CHAR DriverPath[MAX_PATH]; +} SP_DEVINSTALL_PARAMS_A, *PSP_DEVINSTALL_PARAMS_A; + +typedef struct _SP_DEVINSTALL_PARAMS_W { + DWORD cbSize; + DWORD Flags; + DWORD FlagsEx; + HWND hwndParent; + PSP_FILE_CALLBACK InstallMsgHandler; + PVOID InstallMsgHandlerContext; + HSPFILEQ FileQueue; + ULONG_PTR ClassInstallReserved; + DWORD Reserved; + WCHAR DriverPath[MAX_PATH]; +} SP_DEVINSTALL_PARAMS_W, *PSP_DEVINSTALL_PARAMS_W; + +#ifdef UNICODE +typedef SP_DEVINSTALL_PARAMS_W SP_DEVINSTALL_PARAMS; +typedef PSP_DEVINSTALL_PARAMS_W PSP_DEVINSTALL_PARAMS; +#else +typedef SP_DEVINSTALL_PARAMS_A SP_DEVINSTALL_PARAMS; +typedef PSP_DEVINSTALL_PARAMS_A PSP_DEVINSTALL_PARAMS; +#endif + + +// +// SP_DEVINSTALL_PARAMS.Flags values +// +// Flags for choosing a device +// +#define DI_SHOWOEM 0x00000001L // support Other... button +#define DI_SHOWCOMPAT 0x00000002L // show compatibility list +#define DI_SHOWCLASS 0x00000004L // show class list +#define DI_SHOWALL 0x00000007L // both class & compat list shown +#define DI_NOVCP 0x00000008L // don't create a new copy queue--use + // caller-supplied FileQueue +#define DI_DIDCOMPAT 0x00000010L // Searched for compatible devices +#define DI_DIDCLASS 0x00000020L // Searched for class devices +#define DI_AUTOASSIGNRES 0x00000040L // No UI for resources if possible + +// flags returned by DiInstallDevice to indicate need to reboot/restart +#define DI_NEEDRESTART 0x00000080L // Reboot required to take effect +#define DI_NEEDREBOOT 0x00000100L // "" + +// flags for device installation +#define DI_NOBROWSE 0x00000200L // no Browse... in InsertDisk + +// Flags set by DiBuildDriverInfoList +#define DI_MULTMFGS 0x00000400L // Set if multiple manufacturers in + // class driver list + +// Flag indicates that device is disabled +#define DI_DISABLED 0x00000800L // Set if device disabled + +// Flags for Device/Class Properties +#define DI_GENERALPAGE_ADDED 0x00001000L +#define DI_RESOURCEPAGE_ADDED 0x00002000L + +// Flag to indicate the setting properties for this Device (or class) caused a change +// so the Dev Mgr UI probably needs to be updatd. +#define DI_PROPERTIES_CHANGE 0x00004000L + +// Flag to indicate that the sorting from the INF file should be used. +#define DI_INF_IS_SORTED 0x00008000L + +// Flag to indicate that only the the INF specified by SP_DEVINSTALL_PARAMS.DriverPath +// should be searched. +#define DI_ENUMSINGLEINF 0x00010000L + +// Flag that prevents ConfigMgr from removing/re-enumerating devices during device +// registration, installation, and deletion. +#define DI_DONOTCALLCONFIGMG 0x00020000L + +// The following flag can be used to install a device disabled +#define DI_INSTALLDISABLED 0x00040000L + +// Flag that causes SetupDiBuildDriverInfoList to build a device's compatible driver +// list from its existing class driver list, instead of the normal INF search. +#define DI_COMPAT_FROM_CLASS 0x00080000L + +// This flag is set if the Class Install params should be used. +#define DI_CLASSINSTALLPARAMS 0x00100000L + +// This flag is set if the caller of DiCallClassInstaller does NOT +// want the internal default action performed if the Class installer +// returns ERROR_DI_DO_DEFAULT. +#define DI_NODI_DEFAULTACTION 0x00200000L + +// The setupx flag, DI_NOSYNCPROCESSING (0x00400000L) is not support in the Setup APIs. + +// flags for device installation +#define DI_QUIETINSTALL 0x00800000L // don't confuse the user with + // questions or excess info +#define DI_NOFILECOPY 0x01000000L // No file Copy necessary +#define DI_FORCECOPY 0x02000000L // Force files to be copied from install path +#define DI_DRIVERPAGE_ADDED 0x04000000L // Prop provider added Driver page. +#define DI_USECI_SELECTSTRINGS 0x08000000L // Use Class Installer Provided strings in the Select Device Dlg +#define DI_OVERRIDE_INFFLAGS 0x10000000L // Override INF flags +#define DI_PROPS_NOCHANGEUSAGE 0x20000000L // No Enable/Disable in General Props + +#define DI_NOSELECTICONS 0x40000000L // No small icons in select device dialogs + +#define DI_NOWRITE_IDS 0x80000000L // Don't write HW & Compat IDs on install + + +// +// SP_DEVINSTALL_PARAMS.FlagsEx values +// + +#define DI_FLAGSEX_RESERVED2 0x00000001L // DI_FLAGSEX_USEOLDINFSEARCH is obsolete +#define DI_FLAGSEX_RESERVED3 0x00000002L // DI_FLAGSEX_AUTOSELECTRANK0 is obsolete +#define DI_FLAGSEX_CI_FAILED 0x00000004L // Failed to Load/Call class installer + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN // + +#define DI_FLAGSEX_FINISHINSTALL_ACTION 0x00000008L // Class/co-installer wants to get a DIF_FINISH_INSTALL action in client context. + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#define DI_FLAGSEX_DIDINFOLIST 0x00000010L // Did the Class Info List +#define DI_FLAGSEX_DIDCOMPATINFO 0x00000020L // Did the Compat Info List + +#define DI_FLAGSEX_FILTERCLASSES 0x00000040L +#define DI_FLAGSEX_SETFAILEDINSTALL 0x00000080L +#define DI_FLAGSEX_DEVICECHANGE 0x00000100L +#define DI_FLAGSEX_ALWAYSWRITEIDS 0x00000200L +#define DI_FLAGSEX_PROPCHANGE_PENDING 0x00000400L // One or more device property sheets have had changes made + // to them, and need to have a DIF_PROPERTYCHANGE occur. +#define DI_FLAGSEX_ALLOWEXCLUDEDDRVS 0x00000800L +#define DI_FLAGSEX_NOUIONQUERYREMOVE 0x00001000L +#define DI_FLAGSEX_USECLASSFORCOMPAT 0x00002000L // Use the device's class when building compat drv list. + // (Ignored if DI_COMPAT_FROM_CLASS flag is specified.) + +#define DI_FLAGSEX_RESERVED4 0x00004000L // DI_FLAGSEX_OLDINF_IN_CLASSLIST is obsolete + +#define DI_FLAGSEX_NO_DRVREG_MODIFY 0x00008000L // Don't run AddReg and DelReg for device's software (driver) key. +#define DI_FLAGSEX_IN_SYSTEM_SETUP 0x00010000L // Installation is occurring during initial system setup. +#define DI_FLAGSEX_INET_DRIVER 0x00020000L // Driver came from Windows Update +#define DI_FLAGSEX_APPENDDRIVERLIST 0x00040000L // Cause SetupDiBuildDriverInfoList to append + // a new driver list to an existing list. +#define DI_FLAGSEX_PREINSTALLBACKUP 0x00080000L // not used +#define DI_FLAGSEX_BACKUPONREPLACE 0x00100000L // not used +#define DI_FLAGSEX_DRIVERLIST_FROM_URL 0x00200000L // build driver list from INF(s) retrieved from URL specified + // in SP_DEVINSTALL_PARAMS.DriverPath (empty string means + // Windows Update website) +#define DI_FLAGSEX_RESERVED1 0x00400000L +#define DI_FLAGSEX_EXCLUDE_OLD_INET_DRIVERS 0x00800000L // Don't include old Internet drivers when building + // a driver list. + // Ignored on Windows Vista and later. +#define DI_FLAGSEX_POWERPAGE_ADDED 0x01000000L // class installer added their own power page + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define DI_FLAGSEX_FILTERSIMILARDRIVERS 0x02000000L // only include similar drivers in class list +#define DI_FLAGSEX_INSTALLEDDRIVER 0x04000000L // only add the installed driver to the class or compat + // driver list. Used in calls to SetupDiBuildDriverInfoList +#define DI_FLAGSEX_NO_CLASSLIST_NODE_MERGE 0x08000000L // Don't remove identical driver nodes from the class list +#define DI_FLAGSEX_ALTPLATFORM_DRVSEARCH 0x10000000L // Build driver list based on alternate platform information + // specified in associated file queue +#define DI_FLAGSEX_RESTART_DEVICE_ONLY 0x20000000L // only restart the device drivers are being installed on as + // opposed to restarting all devices using those drivers. + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#define DI_FLAGSEX_RECURSIVESEARCH 0x40000000L // Tell SetupDiBuildDriverInfoList to do a recursive search +#define DI_FLAGSEX_SEARCH_PUBLISHED_INFS 0x80000000L // Tell SetupDiBuildDriverInfoList to do a "published INF" search + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +// +// Class installation parameters header. This must be the first field of any +// class install parameter structure. The InstallFunction field must be set to +// the function code corresponding to the structure, and the cbSize field must +// be set to the size of the header structure. E.g., +// +// SP_ENABLECLASS_PARAMS EnableClassParams; +// +// EnableClassParams.ClassInstallHeader.cbSize = sizeof(SP_CLASSINSTALL_HEADER); +// EnableClassParams.ClassInstallHeader.InstallFunction = DIF_ENABLECLASS; +// +typedef struct _SP_CLASSINSTALL_HEADER { + DWORD cbSize; + DI_FUNCTION InstallFunction; +} SP_CLASSINSTALL_HEADER, *PSP_CLASSINSTALL_HEADER; + + +// +// Structure corresponding to a DIF_ENABLECLASS install function. +// +typedef struct _SP_ENABLECLASS_PARAMS { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + GUID ClassGuid; + DWORD EnableMessage; +} SP_ENABLECLASS_PARAMS, *PSP_ENABLECLASS_PARAMS; + +#define ENABLECLASS_QUERY 0 +#define ENABLECLASS_SUCCESS 1 +#define ENABLECLASS_FAILURE 2 + + +// +// Values indicating a change in a device's state +// +#define DICS_ENABLE 0x00000001 +#define DICS_DISABLE 0x00000002 +#define DICS_PROPCHANGE 0x00000003 +#define DICS_START 0x00000004 +#define DICS_STOP 0x00000005 +// +// Values specifying the scope of a device property change +// +#define DICS_FLAG_GLOBAL 0x00000001 // make change in all hardware profiles +#define DICS_FLAG_CONFIGSPECIFIC 0x00000002 // make change in specified profile only +#define DICS_FLAG_CONFIGGENERAL 0x00000004 // 1 or more hardware profile-specific + // changes to follow. +// +// Structure corresponding to a DIF_PROPERTYCHANGE install function. +// +typedef struct _SP_PROPCHANGE_PARAMS { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + DWORD StateChange; + DWORD Scope; + DWORD HwProfile; +} SP_PROPCHANGE_PARAMS, *PSP_PROPCHANGE_PARAMS; + + +// +// Structure corresponding to a DIF_REMOVE install function. +// +typedef struct _SP_REMOVEDEVICE_PARAMS { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + DWORD Scope; + DWORD HwProfile; +} SP_REMOVEDEVICE_PARAMS, *PSP_REMOVEDEVICE_PARAMS; + +#define DI_REMOVEDEVICE_GLOBAL 0x00000001 +#define DI_REMOVEDEVICE_CONFIGSPECIFIC 0x00000002 + + +// +// Structure corresponding to a DIF_UNREMOVE install function. +// +typedef struct _SP_UNREMOVEDEVICE_PARAMS { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + DWORD Scope; + DWORD HwProfile; +} SP_UNREMOVEDEVICE_PARAMS, *PSP_UNREMOVEDEVICE_PARAMS; + +#define DI_UNREMOVEDEVICE_CONFIGSPECIFIC 0x00000002 + + +// +// Structure corresponding to a DIF_SELECTDEVICE install function. +// +typedef struct _SP_SELECTDEVICE_PARAMS_A { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + CHAR Title[MAX_TITLE_LEN]; + CHAR Instructions[MAX_INSTRUCTION_LEN]; + CHAR ListLabel[MAX_LABEL_LEN]; + CHAR SubTitle[MAX_SUBTITLE_LEN]; + BYTE Reserved[2]; // DWORD size alignment +} SP_SELECTDEVICE_PARAMS_A, *PSP_SELECTDEVICE_PARAMS_A; + +typedef struct _SP_SELECTDEVICE_PARAMS_W { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + WCHAR Title[MAX_TITLE_LEN]; + WCHAR Instructions[MAX_INSTRUCTION_LEN]; + WCHAR ListLabel[MAX_LABEL_LEN]; + WCHAR SubTitle[MAX_SUBTITLE_LEN]; +} SP_SELECTDEVICE_PARAMS_W, *PSP_SELECTDEVICE_PARAMS_W; + +#ifdef UNICODE +typedef SP_SELECTDEVICE_PARAMS_W SP_SELECTDEVICE_PARAMS; +typedef PSP_SELECTDEVICE_PARAMS_W PSP_SELECTDEVICE_PARAMS; +#else +typedef SP_SELECTDEVICE_PARAMS_A SP_SELECTDEVICE_PARAMS; +typedef PSP_SELECTDEVICE_PARAMS_A PSP_SELECTDEVICE_PARAMS; +#endif + + +// +// Callback routine for giving progress notification during detection +// +typedef BOOL (CALLBACK* PDETECT_PROGRESS_NOTIFY)( + IN PVOID ProgressNotifyParam, + IN DWORD DetectComplete + ); + +// where: +// ProgressNotifyParam - value supplied by caller requesting detection. +// DetectComplete - Percent completion, to be incremented by class +// installer, as it steps thru its detection. +// +// Return Value - If TRUE, then detection is cancelled. Allows caller +// requesting detection to stop detection asap. +// + +// +// Structure corresponding to a DIF_DETECT install function. +// +typedef struct _SP_DETECTDEVICE_PARAMS { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + PDETECT_PROGRESS_NOTIFY DetectProgressNotify; + PVOID ProgressNotifyParam; +} SP_DETECTDEVICE_PARAMS, *PSP_DETECTDEVICE_PARAMS; + + +// +// 'Add New Device' installation wizard structure (backward-compatibility +// only--respond to DIF_NEWDEVICEWIZARD_* requests instead). +// +// Structure corresponding to a DIF_INSTALLWIZARD install function. +// (NOTE: This structure is also applicable for DIF_DESTROYWIZARDDATA, +// but DIF_INSTALLWIZARD is the associated function code in the class +// installation parameter structure in both cases.) +// +// Define maximum number of dynamic wizard pages that can be added to +// hardware install wizard. +// +#define MAX_INSTALLWIZARD_DYNAPAGES 20 + +typedef struct _SP_INSTALLWIZARD_DATA { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + DWORD Flags; + HPROPSHEETPAGE DynamicPages[MAX_INSTALLWIZARD_DYNAPAGES]; + DWORD NumDynamicPages; + DWORD DynamicPageFlags; + DWORD PrivateFlags; + LPARAM PrivateData; + HWND hwndWizardDlg; +} SP_INSTALLWIZARD_DATA, *PSP_INSTALLWIZARD_DATA; + +// +// SP_INSTALLWIZARD_DATA.Flags values +// +#define NDW_INSTALLFLAG_DIDFACTDEFS 0x00000001 +#define NDW_INSTALLFLAG_HARDWAREALLREADYIN 0x00000002 +#define NDW_INSTALLFLAG_NEEDRESTART DI_NEEDRESTART +#define NDW_INSTALLFLAG_NEEDREBOOT DI_NEEDREBOOT +#define NDW_INSTALLFLAG_NEEDSHUTDOWN 0x00000200 +#define NDW_INSTALLFLAG_EXPRESSINTRO 0x00000400 +#define NDW_INSTALLFLAG_SKIPISDEVINSTALLED 0x00000800 +#define NDW_INSTALLFLAG_NODETECTEDDEVS 0x00001000 +#define NDW_INSTALLFLAG_INSTALLSPECIFIC 0x00002000 +#define NDW_INSTALLFLAG_SKIPCLASSLIST 0x00004000 +#define NDW_INSTALLFLAG_CI_PICKED_OEM 0x00008000 +#define NDW_INSTALLFLAG_PCMCIAMODE 0x00010000 +#define NDW_INSTALLFLAG_PCMCIADEVICE 0x00020000 +#define NDW_INSTALLFLAG_USERCANCEL 0x00040000 +#define NDW_INSTALLFLAG_KNOWNCLASS 0x00080000 + + +// +// SP_INSTALLWIZARD_DATA.DynamicPageFlags values +// +// This flag is set if a Class installer has added pages to the install wizard. +// +#define DYNAWIZ_FLAG_PAGESADDED 0x00000001 + +// +// Set this flag if you jump to the analyze page, and want it to +// handle conflicts for you. NOTE. You will not get control back +// in the event of a conflict if you set this flag. +// +#define DYNAWIZ_FLAG_ANALYZE_HANDLECONFLICT 0x00000008 + +// +// The following flags are not used by the Windows NT hardware wizard. +// +#define DYNAWIZ_FLAG_INSTALLDET_NEXT 0x00000002 +#define DYNAWIZ_FLAG_INSTALLDET_PREV 0x00000004 + + +// +// Reserve a range of wizard page resource IDs for internal use. Some of +// these IDs are for use by class installers that respond to the obsolete +// DIF_INSTALLWIZARD/DIF_DESTROYWIZARDDATA messages. These IDs are listed +// below. +// +#define MIN_IDD_DYNAWIZ_RESOURCE_ID 10000 +#define MAX_IDD_DYNAWIZ_RESOURCE_ID 11000 + +// +// Define wizard page resource IDs to be used when adding custom pages to the +// hardware install wizard via DIF_INSTALLWIZARD. Pages marked with +// (CLASS INSTALLER PROVIDED) _must_ be supplied by the class installer if it +// responds to the DIF_INSTALLWIZARD request. +// + +// +// Resource ID for the first page that the install wizard will go to after +// adding the class installer pages. (CLASS INSTALLER PROVIDED) +// +#define IDD_DYNAWIZ_FIRSTPAGE 10000 + +// +// Resource ID for the page that the Select Device page will go back to. +// (CLASS INSTALLER PROVIDED) +// +#define IDD_DYNAWIZ_SELECT_PREVPAGE 10001 + +// +// Resource ID for the page that the Select Device page will go forward to. +// (CLASS INSTALLER PROVIDED) +// +#define IDD_DYNAWIZ_SELECT_NEXTPAGE 10002 + +// +// Resource ID for the page that the Analyze dialog should go back to +// This will only be used in the event that there is a problem, and the user +// selects Back from the analyze proc. (CLASS INSTALLER PROVIDED) +// +#define IDD_DYNAWIZ_ANALYZE_PREVPAGE 10003 + +// +// Resource ID for the page that the Analyze dialog should go to if it +// continues from the analyze proc. (CLASS INSTALLER PROVIDED) +// +#define IDD_DYNAWIZ_ANALYZE_NEXTPAGE 10004 + +// +// Resource ID of the hardware install wizard's select device page. +// This ID can be used to go directly to the hardware install wizard's select +// device page. (This is the resource ID of the Select Device wizard page +// retrieved via SetupDiGetWizardPage when SPWPT_SELECTDEVICE is the requested +// PageType.) +// +#define IDD_DYNAWIZ_SELECTDEV_PAGE 10009 + +// +// Resource ID of the hardware install wizard's device analysis page. +// This ID can be use to go directly to the hardware install wizard's analysis +// page. +// +#define IDD_DYNAWIZ_ANALYZEDEV_PAGE 10010 + +// +// Resource ID of the hardware install wizard's install detected devices page. +// This ID can be use to go directly to the hardware install wizard's install +// detected devices page. +// +#define IDD_DYNAWIZ_INSTALLDETECTEDDEVS_PAGE 10011 + +// +// Resource ID of the hardware install wizard's select class page. +// This ID can be use to go directly to the hardware install wizard's select +// class page. +// +#define IDD_DYNAWIZ_SELECTCLASS_PAGE 10012 + +// +// The following class installer-provided wizard page resource IDs are not used +// by the Windows NT hardware wizard. +// +#define IDD_DYNAWIZ_INSTALLDETECTED_PREVPAGE 10006 +#define IDD_DYNAWIZ_INSTALLDETECTED_NEXTPAGE 10007 +#define IDD_DYNAWIZ_INSTALLDETECTED_NODEVS 10008 + + +// +// Structure corresponding to the following DIF_NEWDEVICEWIZARD_* install +// functions: +// +// DIF_NEWDEVICEWIZARD_PRESELECT +// DIF_NEWDEVICEWIZARD_SELECT +// DIF_NEWDEVICEWIZARD_PREANALYZE +// DIF_NEWDEVICEWIZARD_POSTANALYZE +// DIF_NEWDEVICEWIZARD_FINISHINSTALL +// +typedef struct _SP_NEWDEVICEWIZARD_DATA { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + DWORD Flags; // presently unused--must be zero. + HPROPSHEETPAGE DynamicPages[MAX_INSTALLWIZARD_DYNAPAGES]; + DWORD NumDynamicPages; + HWND hwndWizardDlg; +} SP_NEWDEVICEWIZARD_DATA, *PSP_NEWDEVICEWIZARD_DATA; + +// +// The same structure is also used for retrieval of property pages via the +// following install functions: +// +// DIF_ADDPROPERTYPAGE_ADVANCED +// DIF_ADDPROPERTYPAGE_BASIC +// DIF_ADDREMOTEPROPERTYPAGE_ADVANCED +// +typedef SP_NEWDEVICEWIZARD_DATA SP_ADDPROPERTYPAGE_DATA; +typedef PSP_NEWDEVICEWIZARD_DATA PSP_ADDPROPERTYPAGE_DATA; + + +// +// Structure corresponding to the DIF_TROUBLESHOOTER install function +// +typedef struct _SP_TROUBLESHOOTER_PARAMS_A { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + CHAR ChmFile[MAX_PATH]; + CHAR HtmlTroubleShooter[MAX_PATH]; +} SP_TROUBLESHOOTER_PARAMS_A, *PSP_TROUBLESHOOTER_PARAMS_A; + +typedef struct _SP_TROUBLESHOOTER_PARAMS_W { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + WCHAR ChmFile[MAX_PATH]; + WCHAR HtmlTroubleShooter[MAX_PATH]; +} SP_TROUBLESHOOTER_PARAMS_W, *PSP_TROUBLESHOOTER_PARAMS_W; + +#ifdef UNICODE +typedef SP_TROUBLESHOOTER_PARAMS_W SP_TROUBLESHOOTER_PARAMS; +typedef PSP_TROUBLESHOOTER_PARAMS_W PSP_TROUBLESHOOTER_PARAMS; +#else +typedef SP_TROUBLESHOOTER_PARAMS_A SP_TROUBLESHOOTER_PARAMS; +typedef PSP_TROUBLESHOOTER_PARAMS_A PSP_TROUBLESHOOTER_PARAMS; +#endif + + +// +// Structure corresponding to the DIF_POWERMESSAGEWAKE install function +// +typedef struct _SP_POWERMESSAGEWAKE_PARAMS_A { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + CHAR PowerMessageWake[LINE_LEN*2]; +} SP_POWERMESSAGEWAKE_PARAMS_A, *PSP_POWERMESSAGEWAKE_PARAMS_A; + +typedef struct _SP_POWERMESSAGEWAKE_PARAMS_W { + SP_CLASSINSTALL_HEADER ClassInstallHeader; + WCHAR PowerMessageWake[LINE_LEN*2]; +} SP_POWERMESSAGEWAKE_PARAMS_W, *PSP_POWERMESSAGEWAKE_PARAMS_W; + +#ifdef UNICODE +typedef SP_POWERMESSAGEWAKE_PARAMS_W SP_POWERMESSAGEWAKE_PARAMS; +typedef PSP_POWERMESSAGEWAKE_PARAMS_W PSP_POWERMESSAGEWAKE_PARAMS; +#else +typedef SP_POWERMESSAGEWAKE_PARAMS_A SP_POWERMESSAGEWAKE_PARAMS; +typedef PSP_POWERMESSAGEWAKE_PARAMS_A PSP_POWERMESSAGEWAKE_PARAMS; +#endif + +// +// Driver information structure (member of a driver info list that may be associated +// with a particular device instance, or (globally) with a device information set) +// +typedef struct _SP_DRVINFO_DATA_V2_A { + DWORD cbSize; + DWORD DriverType; + ULONG_PTR Reserved; + CHAR Description[LINE_LEN]; + CHAR MfgName[LINE_LEN]; + CHAR ProviderName[LINE_LEN]; + FILETIME DriverDate; + DWORDLONG DriverVersion; +} SP_DRVINFO_DATA_V2_A, *PSP_DRVINFO_DATA_V2_A; + +typedef struct _SP_DRVINFO_DATA_V2_W { + DWORD cbSize; + DWORD DriverType; + ULONG_PTR Reserved; + WCHAR Description[LINE_LEN]; + WCHAR MfgName[LINE_LEN]; + WCHAR ProviderName[LINE_LEN]; + FILETIME DriverDate; + DWORDLONG DriverVersion; +} SP_DRVINFO_DATA_V2_W, *PSP_DRVINFO_DATA_V2_W; + +// +// Version 1 of the SP_DRVINFO_DATA structures, used only for compatibility +// with Windows NT 4.0/Windows 95/98 SETUPAPI.DLL +// +typedef struct _SP_DRVINFO_DATA_V1_A { + DWORD cbSize; + DWORD DriverType; + ULONG_PTR Reserved; + CHAR Description[LINE_LEN]; + CHAR MfgName[LINE_LEN]; + CHAR ProviderName[LINE_LEN]; +} SP_DRVINFO_DATA_V1_A, *PSP_DRVINFO_DATA_V1_A; + +typedef struct _SP_DRVINFO_DATA_V1_W { + DWORD cbSize; + DWORD DriverType; + ULONG_PTR Reserved; + WCHAR Description[LINE_LEN]; + WCHAR MfgName[LINE_LEN]; + WCHAR ProviderName[LINE_LEN]; +} SP_DRVINFO_DATA_V1_W, *PSP_DRVINFO_DATA_V1_W; + +#ifdef UNICODE +typedef SP_DRVINFO_DATA_V1_W SP_DRVINFO_DATA_V1; +typedef PSP_DRVINFO_DATA_V1_W PSP_DRVINFO_DATA_V1; +typedef SP_DRVINFO_DATA_V2_W SP_DRVINFO_DATA_V2; +typedef PSP_DRVINFO_DATA_V2_W PSP_DRVINFO_DATA_V2; +#else +typedef SP_DRVINFO_DATA_V1_A SP_DRVINFO_DATA_V1; +typedef PSP_DRVINFO_DATA_V1_A PSP_DRVINFO_DATA_V1; +typedef SP_DRVINFO_DATA_V2_A SP_DRVINFO_DATA_V2; +typedef PSP_DRVINFO_DATA_V2_A PSP_DRVINFO_DATA_V2; +#endif + +#if USE_SP_DRVINFO_DATA_V1 || (_SETUPAPI_VER < _WIN32_WINNT_WIN2K) // use version 1 driver info data structure + +typedef SP_DRVINFO_DATA_V1_A SP_DRVINFO_DATA_A; +typedef PSP_DRVINFO_DATA_V1_A PSP_DRVINFO_DATA_A; +typedef SP_DRVINFO_DATA_V1_W SP_DRVINFO_DATA_W; +typedef PSP_DRVINFO_DATA_V1_W PSP_DRVINFO_DATA_W; +typedef SP_DRVINFO_DATA_V1 SP_DRVINFO_DATA; +typedef PSP_DRVINFO_DATA_V1 PSP_DRVINFO_DATA; + +#else // use version 2 driver info data structure + +typedef SP_DRVINFO_DATA_V2_A SP_DRVINFO_DATA_A; +typedef PSP_DRVINFO_DATA_V2_A PSP_DRVINFO_DATA_A; +typedef SP_DRVINFO_DATA_V2_W SP_DRVINFO_DATA_W; +typedef PSP_DRVINFO_DATA_V2_W PSP_DRVINFO_DATA_W; +typedef SP_DRVINFO_DATA_V2 SP_DRVINFO_DATA; +typedef PSP_DRVINFO_DATA_V2 PSP_DRVINFO_DATA; + +#endif // use current version of driver info data structure + +// +// Driver information details structure (provides detailed information about a +// particular driver information structure) +// +typedef struct _SP_DRVINFO_DETAIL_DATA_A { + DWORD cbSize; + FILETIME InfDate; + DWORD CompatIDsOffset; + DWORD CompatIDsLength; + ULONG_PTR Reserved; + CHAR SectionName[LINE_LEN]; + CHAR InfFileName[MAX_PATH]; + CHAR DrvDescription[LINE_LEN]; + CHAR HardwareID[ANYSIZE_ARRAY]; +} SP_DRVINFO_DETAIL_DATA_A, *PSP_DRVINFO_DETAIL_DATA_A; + +typedef struct _SP_DRVINFO_DETAIL_DATA_W { + DWORD cbSize; + FILETIME InfDate; + DWORD CompatIDsOffset; + DWORD CompatIDsLength; + ULONG_PTR Reserved; + WCHAR SectionName[LINE_LEN]; + WCHAR InfFileName[MAX_PATH]; + WCHAR DrvDescription[LINE_LEN]; + WCHAR HardwareID[ANYSIZE_ARRAY]; +} SP_DRVINFO_DETAIL_DATA_W, *PSP_DRVINFO_DETAIL_DATA_W; + +#ifdef UNICODE +typedef SP_DRVINFO_DETAIL_DATA_W SP_DRVINFO_DETAIL_DATA; +typedef PSP_DRVINFO_DETAIL_DATA_W PSP_DRVINFO_DETAIL_DATA; +#else +typedef SP_DRVINFO_DETAIL_DATA_A SP_DRVINFO_DETAIL_DATA; +typedef PSP_DRVINFO_DETAIL_DATA_A PSP_DRVINFO_DETAIL_DATA; +#endif + + +// +// Driver installation parameters (associated with a particular driver +// information element) +// +typedef struct _SP_DRVINSTALL_PARAMS { + DWORD cbSize; + DWORD Rank; + DWORD Flags; + DWORD_PTR PrivateData; + DWORD Reserved; +} SP_DRVINSTALL_PARAMS, *PSP_DRVINSTALL_PARAMS; + +// +// SP_DRVINSTALL_PARAMS.Flags values +// + +#define DNF_DUPDESC 0x00000001 // Multiple providers have same desc +#define DNF_OLDDRIVER 0x00000002 // Driver node specifies old/current driver +#define DNF_EXCLUDEFROMLIST 0x00000004 // If set, this driver node will not be + // displayed in any driver select dialogs. +#define DNF_NODRIVER 0x00000008 // if we want to install no driver + // (e.g no mouse drv) +#define DNF_LEGACYINF 0x00000010 // Driver node came from an old-style INF (obsolete) +#define DNF_CLASS_DRIVER 0x00000020 // Driver node represents a class driver +#define DNF_COMPATIBLE_DRIVER 0x00000040 // Driver node represents a compatible driver +#define DNF_INET_DRIVER 0x00000080 // Driver comes from an internet source +#define DNF_UNUSED1 0x00000100 +#define DNF_UNUSED2 0x00000200 +#define DNF_OLD_INET_DRIVER 0x00000400 // Driver came from the Internet, but we don't currently + // have access to it's source files. Never attempt to + // install a driver with this flag! + // Note used on Windows Vista and Later. +#define DNF_BAD_DRIVER 0x00000800 // Driver node should not be used at all +#define DNF_DUPPROVIDER 0x00001000 // Multiple drivers have the same provider and desc + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP +#define DNF_INF_IS_SIGNED 0x00002000 // If file is digitally signed +#define DNF_OEM_F6_INF 0x00004000 // INF specified from F6 during textmode setup. +#define DNF_DUPDRIVERVER 0x00008000 // Multipe drivers have the same desc, provider, and DriverVer values +#define DNF_BASIC_DRIVER 0x00010000 // Driver provides basic functionality, but should + // not be chosen if other signed drivers exist. +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_WS03 +#define DNF_AUTHENTICODE_SIGNED 0x00020000 // Inf file is signed by an Authenticode(tm) catalog. +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WS03 + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN +#define DNF_INSTALLEDDRIVER 0x00040000 // This driver node is currently installed on the device. +#define DNF_ALWAYSEXCLUDEFROMLIST 0x00080000 // If set, this driver is not even displayed in + // alternative platform either. +#define DNF_INBOX_DRIVER 0x00100000 // This driver node came from an INF that shipped with Windows. +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#if _SETUPAPI_VER >= _WIN32_WINNT_WIN7 +#define DNF_REQUESTADDITIONALSOFTWARE 0x00200000 // This driver is only part of a software solution needed + // by this device +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WIN7 + +#define DNF_UNUSED_22 0x00400000 +#define DNF_UNUSED_23 0x00800000 +#define DNF_UNUSED_24 0x01000000 +#define DNF_UNUSED_25 0x02000000 +#define DNF_UNUSED_26 0x04000000 +#define DNF_UNUSED_27 0x08000000 +#define DNF_UNUSED_28 0x10000000 +#define DNF_UNUSED_29 0x20000000 +#define DNF_UNUSED_30 0x40000000 +#define DNF_UNUSED_31 0x80000000 + + +// +// Rank values (the lower the Rank number, the better the Rank) +// +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN +#define DRIVER_HARDWAREID_RANK 0x00000FFF // Any rank less than or equal to + // this value is a gold + // HardwareID match + +#define DRIVER_HARDWAREID_MASK 0x80000FFF // If you mask these bits off (AND) + // from the Rank and the result is 0 + // then the Rank is a trusted HardwareID + // match + +#define DRIVER_UNTRUSTED_RANK 0x80000000 // Any rank with this bit set is an + // "untrusted" rank, meaning that + // the INF was unsigned. + +#define DRIVER_W9X_SUSPECT_RANK 0xC0000000 // Any rank that is greater than + // or equal to this value, and lesser + // than or equal to 0xFFFF is suspected + // to be a Win9x-only driver, because + // (a) it isn't signed, and (b) there + // is no NT-specific decoration to + // explicitly indicate that the INF + // supports Windows NT/2000/XP + +#else +#define DRIVER_HARDWAREID_RANK 0x00000FFF // Any rank less than or equal to + // this value is a trusted + // HardwareID match + +#define DRIVER_COMPATID_RANK 0x00003FFF // Any rank less than or equal to + // this (and greater than + // DRIVER_HARDWAREID_RANK) is a + // trusted CompatibleID match + +#define DRIVER_UNTRUSTED_RANK 0x00008000 // Any rank with this bit set is an + // "untrusted" rank, meaning that + // the INF was unsigned. + +#define DRIVER_UNTRUSTED_HARDWAREID_RANK 0x00008FFF // Any rank less than or equal to + // this value (and greater than + // or equal to DRIVER_UNTRUSTED_RANK) + // is an untrusted HardwareID match + +#define DRIVER_UNTRUSTED_COMPATID_RANK 0x0000BFFF // Any rank less than or equal to + // this value (and greater than + // DRIVER_UNTRUSTED_HARDWAREID_RANK) + // is an untrusted CompatibleID match + +#define DRIVER_W9X_SUSPECT_RANK 0x0000C000 // Any rank that is greater than + // or equal to this value, and lesser + // than or equal to 0xFFFF is suspected + // to be a Win9x-only driver, because + // (a) it isn't signed, and (b) there + // is no NT-specific decoration to + // explicitly indicate that the INF + // supports Windows NT/2000/XP + +#define DRIVER_W9X_SUSPECT_HARDWAREID_RANK 0x0000CFFF // Any rank less than or equal to this + // (and greater than or equal to + // DRIVER_W9X_SUSPECT_RANK) is a + // hardware ID match suspected of being + // only for Windows 9x platforms. + +#define DRIVER_W9X_SUSPECT_COMPATID_RANK 0x0000FFFF // Any rank less than or equal to + // this (and greater than + // DRIVER_W9X_SUSPECT_HARDWAREID_RANK) + // is a compatible ID match suspected + // of being only for Windows 9x + // platforms. +#endif // _SETUPAPI_VER < _WIN32_WINNT_LONGHORN + +// +// Setup callback routine for comparing detection signatures +// +typedef DWORD (CALLBACK* PSP_DETSIG_CMPPROC)( + IN HDEVINFO DeviceInfoSet, + IN PSP_DEVINFO_DATA NewDeviceData, + IN PSP_DEVINFO_DATA ExistingDeviceData, + IN PVOID CompareContext OPTIONAL + ); + + +// +// Define context structure handed to co-installers +// +typedef struct _COINSTALLER_CONTEXT_DATA { + BOOL PostProcessing; + DWORD InstallResult; + PVOID PrivateData; +} COINSTALLER_CONTEXT_DATA, *PCOINSTALLER_CONTEXT_DATA; + + +// +// Structure containing class image list information. +// +typedef struct _SP_CLASSIMAGELIST_DATA { + DWORD cbSize; + HIMAGELIST ImageList; + ULONG_PTR Reserved; +} SP_CLASSIMAGELIST_DATA, *PSP_CLASSIMAGELIST_DATA; + + +// +// Structure to be passed as first parameter (LPVOID lpv) to ExtensionPropSheetPageProc +// entry point in setupapi.dll or to "EnumPropPages32" or "BasicProperties32" entry +// points provided by class/device property page providers. Used to retrieve a handle +// (or, potentially, multiple handles) to property pages for a specified property page type. +// +typedef struct _SP_PROPSHEETPAGE_REQUEST { + DWORD cbSize; + DWORD PageRequested; + HDEVINFO DeviceInfoSet; + PSP_DEVINFO_DATA DeviceInfoData; +} SP_PROPSHEETPAGE_REQUEST, *PSP_PROPSHEETPAGE_REQUEST; + +// +// Property sheet codes used in SP_PROPSHEETPAGE_REQUEST.PageRequested +// +#define SPPSR_SELECT_DEVICE_RESOURCES 1 // supplied by setupapi.dll +#define SPPSR_ENUM_BASIC_DEVICE_PROPERTIES 2 // supplied by device's BasicProperties32 provider +#define SPPSR_ENUM_ADV_DEVICE_PROPERTIES 3 // supplied by class and/or device's EnumPropPages32 provider + + +// +// Structure used with SetupGetBackupInformation/SetupSetBackupInformation +// +typedef struct _SP_BACKUP_QUEUE_PARAMS_V2_A { + DWORD cbSize; // size of structure + CHAR FullInfPath[MAX_PATH]; // buffer to hold ANSI pathname of INF file + INT FilenameOffset; // offset in CHAR's of filename part (after '\') + CHAR ReinstallInstance[MAX_PATH]; // Instance ID (if present) +} SP_BACKUP_QUEUE_PARAMS_V2_A, *PSP_BACKUP_QUEUE_PARAMS_V2_A; + +typedef struct _SP_BACKUP_QUEUE_PARAMS_V2_W { + DWORD cbSize; // size of structure + WCHAR FullInfPath[MAX_PATH]; // buffer to hold UNICODE pathname of INF file + INT FilenameOffset; // offset in WCHAR's of filename part (after '\') + WCHAR ReinstallInstance[MAX_PATH]; // Instance ID (if present) +} SP_BACKUP_QUEUE_PARAMS_V2_W, *PSP_BACKUP_QUEUE_PARAMS_V2_W; + +// +// Version 1 of the SP_BACKUP_QUEUE_PARAMS structures, used only for compatibility +// with Windows 2000/Windows 95/98/ME SETUPAPI.DLL +// +typedef struct _SP_BACKUP_QUEUE_PARAMS_V1_A { + DWORD cbSize; // size of structure + CHAR FullInfPath[MAX_PATH]; // buffer to hold ANSI pathname of INF file + INT FilenameOffset; // offset in CHAR's of filename part (after '\') +} SP_BACKUP_QUEUE_PARAMS_V1_A, *PSP_BACKUP_QUEUE_PARAMS_V1_A; + +typedef struct _SP_BACKUP_QUEUE_PARAMS_V1_W { + DWORD cbSize; // size of structure + WCHAR FullInfPath[MAX_PATH]; // buffer to hold UNICODE pathname of INF file + INT FilenameOffset; // offset in WCHAR's of filename part (after '\') +} SP_BACKUP_QUEUE_PARAMS_V1_W, *PSP_BACKUP_QUEUE_PARAMS_V1_W; + +#ifdef UNICODE +typedef SP_BACKUP_QUEUE_PARAMS_V1_W SP_BACKUP_QUEUE_PARAMS_V1; +typedef PSP_BACKUP_QUEUE_PARAMS_V1_W PSP_BACKUP_QUEUE_PARAMS_V1; +typedef SP_BACKUP_QUEUE_PARAMS_V2_W SP_BACKUP_QUEUE_PARAMS_V2; +typedef PSP_BACKUP_QUEUE_PARAMS_V2_W PSP_BACKUP_QUEUE_PARAMS_V2; +#else +typedef SP_BACKUP_QUEUE_PARAMS_V1_A SP_BACKUP_QUEUE_PARAMS_V1; +typedef PSP_BACKUP_QUEUE_PARAMS_V1_A PSP_BACKUP_QUEUE_PARAMS_V1; +typedef SP_BACKUP_QUEUE_PARAMS_V2_A SP_BACKUP_QUEUE_PARAMS_V2; +typedef PSP_BACKUP_QUEUE_PARAMS_V2_A PSP_BACKUP_QUEUE_PARAMS_V2; +#endif + + +#if USE_SP_BACKUP_QUEUE_PARAMS_V1 || (_SETUPAPI_VER < _WIN32_WINNT_WINXP) // use version 1 driver info data structure + +typedef SP_BACKUP_QUEUE_PARAMS_V1_A SP_BACKUP_QUEUE_PARAMS_A; +typedef PSP_BACKUP_QUEUE_PARAMS_V1_A PSP_BACKUP_QUEUE_PARAMS_A; +typedef SP_BACKUP_QUEUE_PARAMS_V1_W SP_BACKUP_QUEUE_PARAMS_W; +typedef PSP_BACKUP_QUEUE_PARAMS_V1_W PSP_BACKUP_QUEUE_PARAMS_W; +typedef SP_BACKUP_QUEUE_PARAMS_V1 SP_BACKUP_QUEUE_PARAMS; +typedef PSP_BACKUP_QUEUE_PARAMS_V1 PSP_BACKUP_QUEUE_PARAMS; + +#else // use version 2 driver info data structure + +typedef SP_BACKUP_QUEUE_PARAMS_V2_A SP_BACKUP_QUEUE_PARAMS_A; +typedef PSP_BACKUP_QUEUE_PARAMS_V2_A PSP_BACKUP_QUEUE_PARAMS_A; +typedef SP_BACKUP_QUEUE_PARAMS_V2_W SP_BACKUP_QUEUE_PARAMS_W; +typedef PSP_BACKUP_QUEUE_PARAMS_V2_W PSP_BACKUP_QUEUE_PARAMS_W; +typedef SP_BACKUP_QUEUE_PARAMS_V2 SP_BACKUP_QUEUE_PARAMS; +typedef PSP_BACKUP_QUEUE_PARAMS_V2 PSP_BACKUP_QUEUE_PARAMS; + +#endif // use current version of driver info data structure + + + + + + + + +// +// Setupapi-specific error codes +// +// Inf parse outcomes +// +#define ERROR_EXPECTED_SECTION_NAME (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0) +#define ERROR_BAD_SECTION_NAME_LINE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|1) +#define ERROR_SECTION_NAME_TOO_LONG (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|2) +#define ERROR_GENERAL_SYNTAX (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|3) +// +// Inf runtime errors +// +#define ERROR_WRONG_INF_STYLE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x100) +#define ERROR_SECTION_NOT_FOUND (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x101) +#define ERROR_LINE_NOT_FOUND (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x102) +#define ERROR_NO_BACKUP (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x103) +// +// Device Installer/other errors +// +#define ERROR_NO_ASSOCIATED_CLASS (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x200) +#define ERROR_CLASS_MISMATCH (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x201) +#define ERROR_DUPLICATE_FOUND (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x202) +#define ERROR_NO_DRIVER_SELECTED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x203) +#define ERROR_KEY_DOES_NOT_EXIST (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x204) +#define ERROR_INVALID_DEVINST_NAME (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x205) +#define ERROR_INVALID_CLASS (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x206) +#define ERROR_DEVINST_ALREADY_EXISTS (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x207) +#define ERROR_DEVINFO_NOT_REGISTERED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x208) +#define ERROR_INVALID_REG_PROPERTY (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x209) +#define ERROR_NO_INF (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x20A) +#define ERROR_NO_SUCH_DEVINST (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x20B) +#define ERROR_CANT_LOAD_CLASS_ICON (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x20C) +#define ERROR_INVALID_CLASS_INSTALLER (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x20D) +#define ERROR_DI_DO_DEFAULT (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x20E) +#define ERROR_DI_NOFILECOPY (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x20F) +#define ERROR_INVALID_HWPROFILE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x210) +#define ERROR_NO_DEVICE_SELECTED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x211) +#define ERROR_DEVINFO_LIST_LOCKED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x212) +#define ERROR_DEVINFO_DATA_LOCKED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x213) +#define ERROR_DI_BAD_PATH (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x214) +#define ERROR_NO_CLASSINSTALL_PARAMS (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x215) +#define ERROR_FILEQUEUE_LOCKED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x216) +#define ERROR_BAD_SERVICE_INSTALLSECT (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x217) +#define ERROR_NO_CLASS_DRIVER_LIST (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x218) +#define ERROR_NO_ASSOCIATED_SERVICE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x219) +#define ERROR_NO_DEFAULT_DEVICE_INTERFACE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x21A) +#define ERROR_DEVICE_INTERFACE_ACTIVE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x21B) +#define ERROR_DEVICE_INTERFACE_REMOVED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x21C) +#define ERROR_BAD_INTERFACE_INSTALLSECT (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x21D) +#define ERROR_NO_SUCH_INTERFACE_CLASS (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x21E) +#define ERROR_INVALID_REFERENCE_STRING (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x21F) +#define ERROR_INVALID_MACHINENAME (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x220) +#define ERROR_REMOTE_COMM_FAILURE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x221) +#define ERROR_MACHINE_UNAVAILABLE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x222) +#define ERROR_NO_CONFIGMGR_SERVICES (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x223) +#define ERROR_INVALID_PROPPAGE_PROVIDER (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x224) +#define ERROR_NO_SUCH_DEVICE_INTERFACE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x225) +#define ERROR_DI_POSTPROCESSING_REQUIRED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x226) +#define ERROR_INVALID_COINSTALLER (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x227) +#define ERROR_NO_COMPAT_DRIVERS (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x228) +#define ERROR_NO_DEVICE_ICON (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x229) +#define ERROR_INVALID_INF_LOGCONFIG (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x22A) +#define ERROR_DI_DONT_INSTALL (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x22B) +#define ERROR_INVALID_FILTER_DRIVER (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x22C) +#define ERROR_NON_WINDOWS_NT_DRIVER (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x22D) +#define ERROR_NON_WINDOWS_DRIVER (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x22E) +#define ERROR_NO_CATALOG_FOR_OEM_INF (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x22F) +#define ERROR_DEVINSTALL_QUEUE_NONNATIVE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x230) +#define ERROR_NOT_DISABLEABLE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x231) +#define ERROR_CANT_REMOVE_DEVINST (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x232) +#define ERROR_INVALID_TARGET (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x233) +#define ERROR_DRIVER_NONNATIVE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x234) +#define ERROR_IN_WOW64 (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x235) +#define ERROR_SET_SYSTEM_RESTORE_POINT (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x236) + +#define ERROR_SCE_DISABLED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x238) +#define ERROR_UNKNOWN_EXCEPTION (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x239) +#define ERROR_PNP_REGISTRY_ERROR (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x23A) +#define ERROR_REMOTE_REQUEST_UNSUPPORTED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x23B) +#define ERROR_NOT_AN_INSTALLED_OEM_INF (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x23C) +#define ERROR_INF_IN_USE_BY_DEVICES (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x23D) +#define ERROR_DI_FUNCTION_OBSOLETE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x23E) +#define ERROR_NO_AUTHENTICODE_CATALOG (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x23F) +#define ERROR_AUTHENTICODE_DISALLOWED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x240) +#define ERROR_AUTHENTICODE_TRUSTED_PUBLISHER (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x241) +#define ERROR_AUTHENTICODE_TRUST_NOT_ESTABLISHED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x242) +#define ERROR_AUTHENTICODE_PUBLISHER_NOT_TRUSTED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x243) +#define ERROR_SIGNATURE_OSATTRIBUTE_MISMATCH (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x244) +#define ERROR_ONLY_VALIDATE_VIA_AUTHENTICODE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x245) +#define ERROR_DEVICE_INSTALLER_NOT_READY (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x246) +#define ERROR_DRIVER_STORE_ADD_FAILED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x247) +#define ERROR_DEVICE_INSTALL_BLOCKED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x248) +#define ERROR_DRIVER_INSTALL_BLOCKED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x249) +#define ERROR_WRONG_INF_TYPE (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x24A) +#define ERROR_FILE_HASH_NOT_IN_CATALOG (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x24B) +#define ERROR_DRIVER_STORE_DELETE_FAILED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x24C) + +// +// Setupapi exception codes +// +#define ERROR_UNRECOVERABLE_STACK_OVERFLOW (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x300) +#define EXCEPTION_SPAPI_UNRECOVERABLE_STACK_OVERFLOW ERROR_UNRECOVERABLE_STACK_OVERFLOW + +// +// Backward compatibility--do not use. +// +#define ERROR_NO_DEFAULT_INTERFACE_DEVICE ERROR_NO_DEFAULT_DEVICE_INTERFACE +#define ERROR_INTERFACE_DEVICE_ACTIVE ERROR_DEVICE_INTERFACE_ACTIVE +#define ERROR_INTERFACE_DEVICE_REMOVED ERROR_DEVICE_INTERFACE_REMOVED +#define ERROR_NO_SUCH_INTERFACE_DEVICE ERROR_NO_SUCH_DEVICE_INTERFACE + + +// +// Win9x migration DLL error code +// +#define ERROR_NOT_INSTALLED (APPLICATION_ERROR_MASK|ERROR_SEVERITY_ERROR|0x1000) + + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfInformationA( + __in LPCVOID InfSpec, + __in DWORD SearchControl, + __out_bcount_opt(ReturnBufferSize) PSP_INF_INFORMATION ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfInformationW( + __in LPCVOID InfSpec, + __in DWORD SearchControl, + __out_bcount_opt(ReturnBufferSize) PSP_INF_INFORMATION ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +// +// SearchControl flags for SetupGetInfInformation +// +#define INFINFO_INF_SPEC_IS_HINF 1 +#define INFINFO_INF_NAME_IS_ABSOLUTE 2 +#define INFINFO_DEFAULT_SEARCH 3 +#define INFINFO_REVERSE_DEFAULT_SEARCH 4 +#define INFINFO_INF_PATH_LIST_SEARCH 5 + +#ifdef UNICODE +#define SetupGetInfInformation SetupGetInfInformationW +#else +#define SetupGetInfInformation SetupGetInfInformationA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueryInfFileInformationA( + __in PSP_INF_INFORMATION InfInformation, + __in UINT InfIndex, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueryInfFileInformationW( + __in PSP_INF_INFORMATION InfInformation, + __in UINT InfIndex, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupQueryInfFileInformation SetupQueryInfFileInformationW +#else +#define SetupQueryInfFileInformation SetupQueryInfFileInformationA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueryInfOriginalFileInformationA( + __in PSP_INF_INFORMATION InfInformation, + __in UINT InfIndex, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __out PSP_ORIGINAL_FILE_INFO_A OriginalFileInfo + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueryInfOriginalFileInformationW( + __in PSP_INF_INFORMATION InfInformation, + __in UINT InfIndex, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __out PSP_ORIGINAL_FILE_INFO_W OriginalFileInfo + ); + +#ifdef UNICODE +#define SetupQueryInfOriginalFileInformation SetupQueryInfOriginalFileInformationW +#else +#define SetupQueryInfOriginalFileInformation SetupQueryInfOriginalFileInformationA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueryInfVersionInformationA( + __in PSP_INF_INFORMATION InfInformation, + __in UINT InfIndex, + __in_opt PCSTR Key, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueryInfVersionInformationW( + __in PSP_INF_INFORMATION InfInformation, + __in UINT InfIndex, + __in_opt PCWSTR Key, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupQueryInfVersionInformation SetupQueryInfVersionInformationW +#else +#define SetupQueryInfVersionInformation SetupQueryInfVersionInformationA +#endif + + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfDriverStoreLocationA( + __in PCSTR FileName, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __in_opt PCSTR LocaleName, + __out_ecount(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfDriverStoreLocationW( + __in PCWSTR FileName, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __in_opt PCWSTR LocaleName, + __out_ecount(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetInfDriverStoreLocation SetupGetInfDriverStoreLocationW +#else +#define SetupGetInfDriverStoreLocation SetupGetInfDriverStoreLocationA +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfPublishedNameA( + __in PCSTR DriverStoreLocation, + __out_ecount(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfPublishedNameW( + __in PCWSTR DriverStoreLocation, + __out_ecount(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetInfPublishedName SetupGetInfPublishedNameW +#else +#define SetupGetInfPublishedName SetupGetInfPublishedNameA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfFileListA( + __in_opt PCSTR DirectoryPath, + __in DWORD InfStyle, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetInfFileListW( + __in_opt PCWSTR DirectoryPath, + __in DWORD InfStyle, + __out_ecount(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetInfFileList SetupGetInfFileListW +#else +#define SetupGetInfFileList SetupGetInfFileListA +#endif + + +WINSETUPAPI +HINF +WINAPI +SetupOpenInfFileW( + __in PCWSTR FileName, + __in_opt PCWSTR InfClass, + __in DWORD InfStyle, + __out_opt PUINT ErrorLine + ); + +WINSETUPAPI +HINF +WINAPI +SetupOpenInfFileA( + __in PCSTR FileName, + __in_opt PCSTR InfClass, + __in DWORD InfStyle, + __out_opt PUINT ErrorLine + ); + +#ifdef UNICODE +#define SetupOpenInfFile SetupOpenInfFileW +#else +#define SetupOpenInfFile SetupOpenInfFileA +#endif + + +WINSETUPAPI +HINF +WINAPI +SetupOpenMasterInf( + VOID + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupOpenAppendInfFileW( + __in_opt PCWSTR FileName, + __in HINF InfHandle, + __out_opt PUINT ErrorLine + ); + +WINSETUPAPI +BOOL +WINAPI +SetupOpenAppendInfFileA( + __in_opt PCSTR FileName, + __in HINF InfHandle, + __out_opt PUINT ErrorLine + ); + +#ifdef UNICODE +#define SetupOpenAppendInfFile SetupOpenAppendInfFileW +#else +#define SetupOpenAppendInfFile SetupOpenAppendInfFileA +#endif + + +WINSETUPAPI +VOID +WINAPI +SetupCloseInfFile( + __in HINF InfHandle + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupFindFirstLineA( + __in HINF InfHandle, + __in PCSTR Section, + __in_opt PCSTR Key, + __out PINFCONTEXT Context + ); + +WINSETUPAPI +BOOL +WINAPI +SetupFindFirstLineW( + __in HINF InfHandle, + __in PCWSTR Section, + __in_opt PCWSTR Key, + __out PINFCONTEXT Context + ); + +#ifdef UNICODE +#define SetupFindFirstLine SetupFindFirstLineW +#else +#define SetupFindFirstLine SetupFindFirstLineA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupFindNextLine( + __in PINFCONTEXT ContextIn, + __out PINFCONTEXT ContextOut + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupFindNextMatchLineA( + __in PINFCONTEXT ContextIn, + __in_opt PCSTR Key, + __out PINFCONTEXT ContextOut + ); + +WINSETUPAPI +BOOL +WINAPI +SetupFindNextMatchLineW( + __in PINFCONTEXT ContextIn, + __in_opt PCWSTR Key, + __out PINFCONTEXT ContextOut + ); + +#ifdef UNICODE +#define SetupFindNextMatchLine SetupFindNextMatchLineW +#else +#define SetupFindNextMatchLine SetupFindNextMatchLineA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupGetLineByIndexA( + __in HINF InfHandle, + __in PCSTR Section, + __in DWORD Index, + __out PINFCONTEXT Context + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetLineByIndexW( + __in HINF InfHandle, + __in PCWSTR Section, + __in DWORD Index, + __out PINFCONTEXT Context + ); + +#ifdef UNICODE +#define SetupGetLineByIndex SetupGetLineByIndexW +#else +#define SetupGetLineByIndex SetupGetLineByIndexA +#endif + + +WINSETUPAPI +LONG +WINAPI +SetupGetLineCountA( + __in HINF InfHandle, + __in PCSTR Section + ); + +WINSETUPAPI +LONG +WINAPI +SetupGetLineCountW( + __in HINF InfHandle, + __in PCWSTR Section + ); + +#ifdef UNICODE +#define SetupGetLineCount SetupGetLineCountW +#else +#define SetupGetLineCount SetupGetLineCountA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupGetLineTextA( + __in_opt PINFCONTEXT Context, + __in_opt HINF InfHandle, + __in_opt PCSTR Section, + __in_opt PCSTR Key, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetLineTextW( + __in_opt PINFCONTEXT Context, + __in_opt HINF InfHandle, + __in_opt PCWSTR Section, + __in_opt PCWSTR Key, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetLineText SetupGetLineTextW +#else +#define SetupGetLineText SetupGetLineTextA +#endif + + +WINSETUPAPI +DWORD +WINAPI +SetupGetFieldCount( + __in PINFCONTEXT Context + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupGetStringFieldA( + __in PINFCONTEXT Context, + __in DWORD FieldIndex, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetStringFieldW( + __in PINFCONTEXT Context, + __in DWORD FieldIndex, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetStringField SetupGetStringFieldW +#else +#define SetupGetStringField SetupGetStringFieldA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupGetIntField( + __in PINFCONTEXT Context, + __in DWORD FieldIndex, + __out PINT IntegerValue + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupGetMultiSzFieldA( + __in PINFCONTEXT Context, + __in DWORD FieldIndex, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt LPDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetMultiSzFieldW( + __in PINFCONTEXT Context, + __in DWORD FieldIndex, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt LPDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetMultiSzField SetupGetMultiSzFieldW +#else +#define SetupGetMultiSzField SetupGetMultiSzFieldA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupGetBinaryField( + __in PINFCONTEXT Context, + __in DWORD FieldIndex, + __out_bcount_opt(ReturnBufferSize) PBYTE ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt LPDWORD RequiredSize + ); + +// +// SetupGetFileCompressionInfo is depreciated +// use SetupGetFileCompressionInfoEx instead +// +// ActualSourceFileName returned by SetupGetFileCompressionInfo +// must be freed by the export setupapi!MyFree (NT4+ Win95+) +// or LocalFree (Win2k+) +// +WINSETUPAPI +DWORD +WINAPI +SetupGetFileCompressionInfoA( + __in PCSTR SourceFileName, + __out PSTR *ActualSourceFileName, + __out PDWORD SourceFileSize, + __out PDWORD TargetFileSize, + __out PUINT CompressionType + ); + +WINSETUPAPI +DWORD +WINAPI +SetupGetFileCompressionInfoW( + __in PCWSTR SourceFileName, + __out PWSTR *ActualSourceFileName, + __out PDWORD SourceFileSize, + __out PDWORD TargetFileSize, + __out PUINT CompressionType + ); + +#ifdef UNICODE +#define SetupGetFileCompressionInfo SetupGetFileCompressionInfoW +#else +#define SetupGetFileCompressionInfo SetupGetFileCompressionInfoA +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// SetupGetFileCompressionInfoEx is the preferred API over +// SetupGetFileCompressionInfo. It follows the normal +// conventions of returning BOOL and writing to user-supplied +// buffer. +// + +WINSETUPAPI +BOOL +WINAPI +SetupGetFileCompressionInfoExA( + __in PCSTR SourceFileName, + __in_ecount_opt(ActualSourceFileNameBufferLen) PSTR ActualSourceFileNameBuffer, + __in DWORD ActualSourceFileNameBufferLen, + __out_opt PDWORD RequiredBufferLen, + __out PDWORD SourceFileSize, + __out PDWORD TargetFileSize, + __out PUINT CompressionType + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetFileCompressionInfoExW( + __in PCWSTR SourceFileName, + __in_ecount_opt(ActualSourceFileNameBufferLen) PWSTR ActualSourceFileNameBuffer, + __in DWORD ActualSourceFileNameBufferLen, + __out_opt PDWORD RequiredBufferLen, + __out PDWORD SourceFileSize, + __out PDWORD TargetFileSize, + __out PUINT CompressionType + ); + +#ifdef UNICODE +#define SetupGetFileCompressionInfoEx SetupGetFileCompressionInfoExW +#else +#define SetupGetFileCompressionInfoEx SetupGetFileCompressionInfoExA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Compression types +// +#define FILE_COMPRESSION_NONE 0 +#define FILE_COMPRESSION_WINLZA 1 +#define FILE_COMPRESSION_MSZIP 2 +#define FILE_COMPRESSION_NTCAB 3 + + +WINSETUPAPI +DWORD +WINAPI +SetupDecompressOrCopyFileA( + __in PCSTR SourceFileName, + __in PCSTR TargetFileName, + __in_opt PUINT CompressionType + ); + +WINSETUPAPI +DWORD +WINAPI +SetupDecompressOrCopyFileW( + __in PCWSTR SourceFileName, + __in PCWSTR TargetFileName, + __in_opt PUINT CompressionType + ); + +#ifdef UNICODE +#define SetupDecompressOrCopyFile SetupDecompressOrCopyFileW +#else +#define SetupDecompressOrCopyFile SetupDecompressOrCopyFileA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupGetSourceFileLocationA( + __in HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCSTR FileName, + __out PUINT SourceId, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetSourceFileLocationW( + __in HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCWSTR FileName, + __out PUINT SourceId, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetSourceFileLocation SetupGetSourceFileLocationW +#else +#define SetupGetSourceFileLocation SetupGetSourceFileLocationA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupGetSourceFileSizeA( + __in HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCSTR FileName, + __in_opt PCSTR Section, + __out PDWORD FileSize, + __in UINT RoundingFactor + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetSourceFileSizeW( + __in HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCWSTR FileName, + __in_opt PCWSTR Section, + __out PDWORD FileSize, + __in UINT RoundingFactor + ); + +#ifdef UNICODE +#define SetupGetSourceFileSize SetupGetSourceFileSizeW +#else +#define SetupGetSourceFileSize SetupGetSourceFileSizeA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupGetTargetPathA( + __in HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCSTR Section, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetTargetPathW( + __in HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCWSTR Section, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetTargetPath SetupGetTargetPathW +#else +#define SetupGetTargetPath SetupGetTargetPathA +#endif + + +// +// Define flags for SourceList APIs. +// +#define SRCLIST_TEMPORARY 0x00000001 +#define SRCLIST_NOBROWSE 0x00000002 +#define SRCLIST_SYSTEM 0x00000010 +#define SRCLIST_USER 0x00000020 +#define SRCLIST_SYSIFADMIN 0x00000040 +#define SRCLIST_SUBDIRS 0x00000100 +#define SRCLIST_APPEND 0x00000200 +#define SRCLIST_NOSTRIPPLATFORM 0x00000400 + + +WINSETUPAPI +BOOL +WINAPI +SetupSetSourceListA( + __in DWORD Flags, + __in_ecount(SourceCount) PCSTR *SourceList, + __in UINT SourceCount + ); + +WINSETUPAPI +BOOL +WINAPI +SetupSetSourceListW( + __in DWORD Flags, + __in_ecount(SourceCount) PCWSTR *SourceList, + __in UINT SourceCount + ); + +#ifdef UNICODE +#define SetupSetSourceList SetupSetSourceListW +#else +#define SetupSetSourceList SetupSetSourceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupCancelTemporarySourceList( + VOID + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupAddToSourceListA( + __in DWORD Flags, + __in PCSTR Source + ); + +WINSETUPAPI +BOOL +WINAPI +SetupAddToSourceListW( + __in DWORD Flags, + __in PCWSTR Source + ); + +#ifdef UNICODE +#define SetupAddToSourceList SetupAddToSourceListW +#else +#define SetupAddToSourceList SetupAddToSourceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveFromSourceListA( + __in DWORD Flags, + __in PCSTR Source + ); + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveFromSourceListW( + __in DWORD Flags, + __in PCWSTR Source + ); + +#ifdef UNICODE +#define SetupRemoveFromSourceList SetupRemoveFromSourceListW +#else +#define SetupRemoveFromSourceList SetupRemoveFromSourceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQuerySourceListA( + __in DWORD Flags, + __deref_out_ecount(*Count) PCSTR **List, + __out PUINT Count + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQuerySourceListW( + __in DWORD Flags, + __deref_out_ecount(*Count) PCWSTR **List, + __out PUINT Count + ); + +#ifdef UNICODE +#define SetupQuerySourceList SetupQuerySourceListW +#else +#define SetupQuerySourceList SetupQuerySourceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupFreeSourceListA( + __deref_inout_ecount(Count) PCSTR **List, + __in UINT Count + ); + +WINSETUPAPI +BOOL +WINAPI +SetupFreeSourceListW( + __deref_inout_ecount(Count) PCWSTR **List, + __in UINT Count + ); + +#ifdef UNICODE +#define SetupFreeSourceList SetupFreeSourceListW +#else +#define SetupFreeSourceList SetupFreeSourceListA +#endif + + +WINSETUPAPI +UINT +WINAPI +SetupPromptForDiskA( + __in HWND hwndParent, + __in_opt PCSTR DialogTitle, + __in_opt PCSTR DiskName, + __in_opt PCSTR PathToSource, + __in PCSTR FileSought, + __in_opt PCSTR TagFile, + __in DWORD DiskPromptStyle, + __out_ecount_opt(PathBufferSize) PSTR PathBuffer, + __in DWORD PathBufferSize, + __out_opt PDWORD PathRequiredSize + ); + +WINSETUPAPI +UINT +WINAPI +SetupPromptForDiskW( + __in HWND hwndParent, + __in_opt PCWSTR DialogTitle, + __in_opt PCWSTR DiskName, + __in_opt PCWSTR PathToSource, + __in PCWSTR FileSought, + __in_opt PCWSTR TagFile, + __in DWORD DiskPromptStyle, + __out_ecount_opt(PathBufferSize) PWSTR PathBuffer, + __in DWORD PathBufferSize, + __out_opt PDWORD PathRequiredSize + ); + +#ifdef UNICODE +#define SetupPromptForDisk SetupPromptForDiskW +#else +#define SetupPromptForDisk SetupPromptForDiskA +#endif + + +WINSETUPAPI +UINT +WINAPI +SetupCopyErrorA( + __in HWND hwndParent, + __in_opt PCSTR DialogTitle, + __in_opt PCSTR DiskName, + __in PCSTR PathToSource, + __in PCSTR SourceFile, + __in_opt PCSTR TargetPathFile, + __in UINT Win32ErrorCode, + __in DWORD Style, + __out_ecount_opt(PathBufferSize) PSTR PathBuffer, + __in DWORD PathBufferSize, + __out_opt PDWORD PathRequiredSize + ); + +WINSETUPAPI +UINT +WINAPI +SetupCopyErrorW( + __in HWND hwndParent, + __in_opt PCWSTR DialogTitle, + __in_opt PCWSTR DiskName, + __in PCWSTR PathToSource, + __in PCWSTR SourceFile, + __in_opt PCWSTR TargetPathFile, + __in UINT Win32ErrorCode, + __in DWORD Style, + __out_ecount_opt(PathBufferSize) PWSTR PathBuffer, + __in DWORD PathBufferSize, + __out_opt PDWORD PathRequiredSize + ); + +#ifdef UNICODE +#define SetupCopyError SetupCopyErrorW +#else +#define SetupCopyError SetupCopyErrorA +#endif + + +WINSETUPAPI +UINT +WINAPI +SetupRenameErrorA( + __in HWND hwndParent, + __in_opt PCSTR DialogTitle, + __in PCSTR SourceFile, + __in PCSTR TargetFile, + __in UINT Win32ErrorCode, + __in DWORD Style + ); + +WINSETUPAPI +UINT +WINAPI +SetupRenameErrorW( + __in HWND hwndParent, + __in_opt PCWSTR DialogTitle, + __in PCWSTR SourceFile, + __in PCWSTR TargetFile, + __in UINT Win32ErrorCode, + __in DWORD Style + ); + +#ifdef UNICODE +#define SetupRenameError SetupRenameErrorW +#else +#define SetupRenameError SetupRenameErrorA +#endif + + +WINSETUPAPI +UINT +WINAPI +SetupDeleteErrorA( + __in HWND hwndParent, + __in_opt PCSTR DialogTitle, + __in PCSTR File, + __in UINT Win32ErrorCode, + __in DWORD Style + ); + +WINSETUPAPI +UINT +WINAPI +SetupDeleteErrorW( + __in HWND hwndParent, + __in_opt PCWSTR DialogTitle, + __in PCWSTR File, + __in UINT Win32ErrorCode, + __in DWORD Style + ); + +#ifdef UNICODE +#define SetupDeleteError SetupDeleteErrorW +#else +#define SetupDeleteError SetupDeleteErrorA +#endif + +WINSETUPAPI +UINT +WINAPI +SetupBackupErrorA( + __in HWND hwndParent, + __in_opt PCSTR DialogTitle, + __in PCSTR SourceFile, + __in_opt PCSTR TargetFile, + __in UINT Win32ErrorCode, + __in DWORD Style + ); + +WINSETUPAPI +UINT +WINAPI +SetupBackupErrorW( + __in HWND hwndParent, + __in_opt PCWSTR DialogTitle, + __in PCWSTR SourceFile, + __in_opt PCWSTR TargetFile, + __in UINT Win32ErrorCode, + __in DWORD Style + ); + +#ifdef UNICODE +#define SetupBackupError SetupBackupErrorW +#else +#define SetupBackupError SetupBackupErrorA +#endif + + +// +// Styles for SetupPromptForDisk, SetupCopyError, +// SetupRenameError, SetupDeleteError +// +#define IDF_NOBROWSE 0x00000001 +#define IDF_NOSKIP 0x00000002 +#define IDF_NODETAILS 0x00000004 +#define IDF_NOCOMPRESSED 0x00000008 +#define IDF_CHECKFIRST 0x00000100 +#define IDF_NOBEEP 0x00000200 +#define IDF_NOFOREGROUND 0x00000400 +#define IDF_WARNIFSKIP 0x00000800 + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define IDF_NOREMOVABLEMEDIAPROMPT 0x00001000 +#define IDF_USEDISKNAMEASPROMPT 0x00002000 +#define IDF_OEMDISK 0x80000000 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Return values for SetupPromptForDisk, SetupCopyError, +// SetupRenameError, SetupDeleteError, SetupBackupError +// +#define DPROMPT_SUCCESS 0 +#define DPROMPT_CANCEL 1 +#define DPROMPT_SKIPFILE 2 +#define DPROMPT_BUFFERTOOSMALL 3 +#define DPROMPT_OUTOFMEMORY 4 + + +WINSETUPAPI +BOOL +WINAPI +SetupSetDirectoryIdA( + __in HINF InfHandle, + __in DWORD Id, + __in_opt PCSTR Directory + ); + +WINSETUPAPI +BOOL +WINAPI +SetupSetDirectoryIdW( + __in HINF InfHandle, + __in DWORD Id, + __in_opt PCWSTR Directory + ); + +#ifdef UNICODE +#define SetupSetDirectoryId SetupSetDirectoryIdW +#else +#define SetupSetDirectoryId SetupSetDirectoryIdA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupSetDirectoryIdExA( + __in HINF InfHandle, + __in DWORD Id, + __in_opt PCSTR Directory, + __in DWORD Flags, + __reserved DWORD Reserved1, + __reserved PVOID Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupSetDirectoryIdExW( + __in HINF InfHandle, + __in DWORD Id, + __in_opt PCWSTR Directory, + __in DWORD Flags, + __reserved DWORD Reserved1, + __reserved PVOID Reserved2 + ); + +#ifdef UNICODE +#define SetupSetDirectoryIdEx SetupSetDirectoryIdExW +#else +#define SetupSetDirectoryIdEx SetupSetDirectoryIdExA +#endif + +// +// Flags for SetupSetDirectoryIdEx +// +#define SETDIRID_NOT_FULL_PATH 0x00000001 + + +WINSETUPAPI +BOOL +WINAPI +SetupGetSourceInfoA( + __in HINF InfHandle, + __in UINT SourceId, + __in UINT InfoDesired, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetSourceInfoW( + __in HINF InfHandle, + __in UINT SourceId, + __in UINT InfoDesired, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupGetSourceInfo SetupGetSourceInfoW +#else +#define SetupGetSourceInfo SetupGetSourceInfoA +#endif + +// +// InfoDesired values for SetupGetSourceInfo +// + +#define SRCINFO_PATH 1 +#define SRCINFO_TAGFILE 2 +#define SRCINFO_DESCRIPTION 3 +#define SRCINFO_FLAGS 4 + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP +// +// SRC_FLAGS allow special treatment of source +// lower 4 bits are reserved for OS use +// the flags may determine what other parameters exist +// +#define SRCINFO_TAGFILE2 5 // alternate tagfile, when SRCINFO_TAGFILE is a cabfile + +#define SRC_FLAGS_CABFILE (0x0010) // if set, treat SRCINFO_TAGFILE as a cabfile and specify alternate tagfile + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFileA( + __in_opt HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCSTR SourceFile, + __in_opt PCSTR SourcePathRoot, + __in_opt PCSTR DestinationName, + __in DWORD CopyStyle, + __in_opt PSP_FILE_CALLBACK_A CopyMsgHandler, + __in_opt PVOID Context + ); + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFileW( + __in_opt HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCWSTR SourceFile, + __in_opt PCWSTR SourcePathRoot, + __in_opt PCWSTR DestinationName, + __in DWORD CopyStyle, + __in_opt PSP_FILE_CALLBACK_W CopyMsgHandler, + __in_opt PVOID Context + ); + +#ifdef UNICODE +#define SetupInstallFile SetupInstallFileW +#else +#define SetupInstallFile SetupInstallFileA +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFileExA( + __in_opt HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCSTR SourceFile, + __in_opt PCSTR SourcePathRoot, + __in_opt PCSTR DestinationName, + __in DWORD CopyStyle, + __in_opt PSP_FILE_CALLBACK_A CopyMsgHandler, + __in_opt PVOID Context, + __out PBOOL FileWasInUse + ); + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFileExW( + __in_opt HINF InfHandle, + __in_opt PINFCONTEXT InfContext, + __in_opt PCWSTR SourceFile, + __in_opt PCWSTR SourcePathRoot, + __in_opt PCWSTR DestinationName, + __in DWORD CopyStyle, + __in_opt PSP_FILE_CALLBACK_W CopyMsgHandler, + __in_opt PVOID Context, + __out PBOOL FileWasInUse + ); + +#ifdef UNICODE +#define SetupInstallFileEx SetupInstallFileExW +#else +#define SetupInstallFileEx SetupInstallFileExA +#endif + +// +// CopyStyle values for copy and queue-related APIs +// +#define SP_COPY_DELETESOURCE 0x0000001 // delete source file on successful copy +#define SP_COPY_REPLACEONLY 0x0000002 // copy only if target file already present +#define SP_COPY_NEWER 0x0000004 // copy only if source newer than or same as target +#define SP_COPY_NEWER_OR_SAME SP_COPY_NEWER +#define SP_COPY_NOOVERWRITE 0x0000008 // copy only if target doesn't exist +#define SP_COPY_NODECOMP 0x0000010 // don't decompress source file while copying +#define SP_COPY_LANGUAGEAWARE 0x0000020 // don't overwrite file of different language +#define SP_COPY_SOURCE_ABSOLUTE 0x0000040 // SourceFile is a full source path +#define SP_COPY_SOURCEPATH_ABSOLUTE 0x0000080 // SourcePathRoot is the full path +#define SP_COPY_IN_USE_NEEDS_REBOOT 0x0000100 // System needs reboot if file in use +#define SP_COPY_FORCE_IN_USE 0x0000200 // Force target-in-use behavior +#define SP_COPY_NOSKIP 0x0000400 // Skip is disallowed for this file or section +#define SP_FLAG_CABINETCONTINUATION 0x0000800 // Used with need media notification +#define SP_COPY_FORCE_NOOVERWRITE 0x0001000 // like NOOVERWRITE but no callback nofitication +#define SP_COPY_FORCE_NEWER 0x0002000 // like NEWER but no callback nofitication +#define SP_COPY_WARNIFSKIP 0x0004000 // system critical file: warn if user tries to skip +#define SP_COPY_NOBROWSE 0x0008000 // Browsing is disallowed for this file or section +#define SP_COPY_NEWER_ONLY 0x0010000 // copy only if source file newer than target +#define SP_COPY_RESERVED 0x0020000 // was: SP_COPY_SOURCE_SIS_MASTER (deprecated) +#define SP_COPY_OEMINF_CATALOG_ONLY 0x0040000 // (SetupCopyOEMInf only) don't copy INF--just catalog +#define SP_COPY_REPLACE_BOOT_FILE 0x0080000 // file must be present upon reboot (i.e., it's + // needed by the loader); this flag implies a reboot +#define SP_COPY_NOPRUNE 0x0100000 // never prune this file + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define SP_COPY_OEM_F6_INF 0x0200000 // Used when calling SetupCopyOemInf + +#endif //_SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define SP_COPY_ALREADYDECOMP 0x0400000 // similar to SP_COPY_NODECOMP + +#endif //_SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#define SP_COPY_WINDOWS_SIGNED 0x1000000 // BuildLab or WinSE signed +#define SP_COPY_PNPLOCKED 0x2000000 // Used with the signature flag +#define SP_COPY_IN_USE_TRY_RENAME 0x4000000 // If file in use, try to rename the target first +#define SP_COPY_INBOX_INF 0x8000000 // Referred by CopyFiles of inbox inf + +#endif //_SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#if _SETUPAPI_VER >= _WIN32_WINNT_WIN7 + +#define SP_COPY_HARDLINK 0x10000000 // Copy using hardlink, if possible + +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Flags passed to Backup notification +// +#define SP_BACKUP_BACKUPPASS 0x00000001 // file backed up during backup pass +#define SP_BACKUP_DEMANDPASS 0x00000002 // file backed up on demand +#define SP_BACKUP_SPECIAL 0x00000004 // if set, special type of backup +#define SP_BACKUP_BOOTFILE 0x00000008 // file marked with COPYFLG_REPLACE_BOOT_FILE + + +#endif //_SETUPAPI_VER >= _WIN32_WINNT_WINXP + + +WINSETUPAPI +HSPFILEQ +WINAPI +SetupOpenFileQueue( + VOID + ); + +WINSETUPAPI +BOOL +WINAPI +SetupCloseFileQueue( + __in HSPFILEQ QueueHandle + ); + +WINSETUPAPI +BOOL +WINAPI +SetupSetFileQueueAlternatePlatformA( + __in HSPFILEQ QueueHandle, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __in_opt PCSTR AlternateDefaultCatalogFile + ); + +WINSETUPAPI +BOOL +WINAPI +SetupSetFileQueueAlternatePlatformW( + __in HSPFILEQ QueueHandle, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __in_opt PCWSTR AlternateDefaultCatalogFile + ); + +#ifdef UNICODE +#define SetupSetFileQueueAlternatePlatform SetupSetFileQueueAlternatePlatformW +#else +#define SetupSetFileQueueAlternatePlatform SetupSetFileQueueAlternatePlatformA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupSetPlatformPathOverrideA( + __in_opt PCSTR Override + ); + +WINSETUPAPI +BOOL +WINAPI +SetupSetPlatformPathOverrideW( + __in_opt PCWSTR Override + ); + +#ifdef UNICODE +#define SetupSetPlatformPathOverride SetupSetPlatformPathOverrideW +#else +#define SetupSetPlatformPathOverride SetupSetPlatformPathOverrideA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueCopyA( + __in HSPFILEQ QueueHandle, + __in_opt PCSTR SourceRootPath, + __in_opt PCSTR SourcePath, + __in PCSTR SourceFilename, + __in_opt PCSTR SourceDescription, + __in_opt PCSTR SourceTagfile, + __in PCSTR TargetDirectory, + __in_opt PCSTR TargetFilename, + __in DWORD CopyStyle + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueCopyW( + __in HSPFILEQ QueueHandle, + __in_opt PCWSTR SourceRootPath, + __in_opt PCWSTR SourcePath, + __in PCWSTR SourceFilename, + __in_opt PCWSTR SourceDescription, + __in_opt PCWSTR SourceTagfile, + __in PCWSTR TargetDirectory, + __in_opt PCWSTR TargetFilename, + __in DWORD CopyStyle + ); + +#ifdef UNICODE +#define SetupQueueCopy SetupQueueCopyW +#else +#define SetupQueueCopy SetupQueueCopyA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueCopyIndirectA( + __in PSP_FILE_COPY_PARAMS_A CopyParams + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueCopyIndirectW( + __in PSP_FILE_COPY_PARAMS_W CopyParams + ); + +#ifdef UNICODE +#define SetupQueueCopyIndirect SetupQueueCopyIndirectW +#else +#define SetupQueueCopyIndirect SetupQueueCopyIndirectA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueDefaultCopyA( + __in HSPFILEQ QueueHandle, + __in HINF InfHandle, + __in_opt PCSTR SourceRootPath, + __in PCSTR SourceFilename, + __in_opt PCSTR TargetFilename, + __in DWORD CopyStyle + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueDefaultCopyW( + __in HSPFILEQ QueueHandle, + __in HINF InfHandle, + __in_opt PCWSTR SourceRootPath, + __in PCWSTR SourceFilename, + __in_opt PCWSTR TargetFilename, + __in DWORD CopyStyle + ); + +#ifdef UNICODE +#define SetupQueueDefaultCopy SetupQueueDefaultCopyW +#else +#define SetupQueueDefaultCopy SetupQueueDefaultCopyA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueCopySectionA( + __in HSPFILEQ QueueHandle, + __in_opt PCSTR SourceRootPath, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCSTR Section, + __in DWORD CopyStyle + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueCopySectionW( + __in HSPFILEQ QueueHandle, + __in_opt PCWSTR SourceRootPath, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCWSTR Section, + __in DWORD CopyStyle + ); + +#ifdef UNICODE +#define SetupQueueCopySection SetupQueueCopySectionW +#else +#define SetupQueueCopySection SetupQueueCopySectionA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueDeleteA( + __in HSPFILEQ QueueHandle, + __in PCSTR PathPart1, + __in_opt PCSTR PathPart2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueDeleteW( + __in HSPFILEQ QueueHandle, + __in PCWSTR PathPart1, + __in_opt PCWSTR PathPart2 + ); + +#ifdef UNICODE +#define SetupQueueDelete SetupQueueDeleteW +#else +#define SetupQueueDelete SetupQueueDeleteA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueDeleteSectionA( + __in HSPFILEQ QueueHandle, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCSTR Section + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueDeleteSectionW( + __in HSPFILEQ QueueHandle, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCWSTR Section + ); + +#ifdef UNICODE +#define SetupQueueDeleteSection SetupQueueDeleteSectionW +#else +#define SetupQueueDeleteSection SetupQueueDeleteSectionA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueRenameA( + __in HSPFILEQ QueueHandle, + __in PCSTR SourcePath, + __in_opt PCSTR SourceFilename, + __in_opt PCSTR TargetPath, + __in PCSTR TargetFilename + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueRenameW( + __in HSPFILEQ QueueHandle, + __in PCWSTR SourcePath, + __in_opt PCWSTR SourceFilename, + __in_opt PCWSTR TargetPath, + __in PCWSTR TargetFilename + ); + +#ifdef UNICODE +#define SetupQueueRename SetupQueueRenameW +#else +#define SetupQueueRename SetupQueueRenameA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQueueRenameSectionA( + __in HSPFILEQ QueueHandle, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCSTR Section + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueueRenameSectionW( + __in HSPFILEQ QueueHandle, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCWSTR Section + ); + +#ifdef UNICODE +#define SetupQueueRenameSection SetupQueueRenameSectionW +#else +#define SetupQueueRenameSection SetupQueueRenameSectionA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupCommitFileQueueA( + __in_opt HWND Owner, + __in HSPFILEQ QueueHandle, + __in PSP_FILE_CALLBACK_A MsgHandler, + __in PVOID Context + ); + +WINSETUPAPI +BOOL +WINAPI +SetupCommitFileQueueW( + __in_opt HWND Owner, + __in HSPFILEQ QueueHandle, + __in PSP_FILE_CALLBACK_W MsgHandler, + __in PVOID Context + ); + +#ifdef UNICODE +#define SetupCommitFileQueue SetupCommitFileQueueW +#else +#define SetupCommitFileQueue SetupCommitFileQueueA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupScanFileQueueA( + __in HSPFILEQ FileQueue, + __in DWORD Flags, + __in_opt HWND Window, + __in_opt PSP_FILE_CALLBACK_A CallbackRoutine, + __in_opt PVOID CallbackContext, + __out PDWORD Result + ); + +WINSETUPAPI +BOOL +WINAPI +SetupScanFileQueueW( + __in HSPFILEQ FileQueue, + __in DWORD Flags, + __in_opt HWND Window, + __in_opt PSP_FILE_CALLBACK_W CallbackRoutine, + __in_opt PVOID CallbackContext, + __out PDWORD Result + ); + +#ifdef UNICODE +#define SetupScanFileQueue SetupScanFileQueueW +#else +#define SetupScanFileQueue SetupScanFileQueueA +#endif + +// +// Define flags for SetupScanFileQueue. +// +#define SPQ_SCAN_FILE_PRESENCE 0x00000001 +#define SPQ_SCAN_FILE_VALIDITY 0x00000002 +#define SPQ_SCAN_USE_CALLBACK 0x00000004 +#define SPQ_SCAN_USE_CALLBACKEX 0x00000008 +#define SPQ_SCAN_INFORM_USER 0x00000010 +#define SPQ_SCAN_PRUNE_COPY_QUEUE 0x00000020 + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define SPQ_SCAN_USE_CALLBACK_SIGNERINFO 0x00000040 +#define SPQ_SCAN_PRUNE_DELREN 0x00000080 // remote Delete/Rename queue + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#define SPQ_SCAN_FILE_PRESENCE_WITHOUT_SOURCE 0x00000100 +#define SPQ_SCAN_FILE_COMPARISON 0x00000200 +#define SPQ_SCAN_ACTIVATE_DRP 0x00000400 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +// +// Define flags used with Param2 for SPFILENOTIFY_QUEUESCAN +// +#define SPQ_DELAYED_COPY 0x00000001 // file was in use; registered for delayed copy + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupGetFileQueueCount( + __in HSPFILEQ FileQueue, + __in UINT SubQueueFileOp, + __out PUINT NumOperations + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetFileQueueFlags( + __in HSPFILEQ FileQueue, + __out PDWORD Flags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupSetFileQueueFlags( + __in HSPFILEQ FileQueue, + __in DWORD FlagMask, + __in DWORD Flags + ); + +// +// Flags/FlagMask for use with SetupSetFileQueueFlags and returned by SetupGetFileQueueFlags +// +#define SPQ_FLAG_BACKUP_AWARE 0x00000001 // If set, SetupCommitFileQueue will + // issue backup notifications. + +#define SPQ_FLAG_ABORT_IF_UNSIGNED 0x00000002 // If set, SetupCommitFileQueue will + // fail with ERROR_SET_SYSTEM_RESTORE_POINT + // if the user elects to proceed with an + // unsigned queue committal. This allows + // the caller to set a system restore point, + // then re-commit the file queue. + +#define SPQ_FLAG_FILES_MODIFIED 0x00000004 // If set, at least one file was + // replaced by a different version + +#define SPQ_FLAG_DO_SHUFFLEMOVE 0x00000008 // If set then always do a shuffle move. A shuffle + // move will first try to copy the source over the + // destination file, but if the destination file is + // in use it will rename the destination file to a + // temp name and queue the temp name for deletion. + // It will then be free to copy the source to the + // destination name. It is considered an error if + // the destination file can't be renamed for some + // reason. + +#define SPQ_FLAG_VALID 0x0000000F // mask of valid flags (can be passed as FlagMask) + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Define OEM Source Type values for use in SetupCopyOEMInf. +// +#define SPOST_NONE 0 +#define SPOST_PATH 1 +#define SPOST_URL 2 +#define SPOST_MAX 3 + +WINSETUPAPI +BOOL +WINAPI +SetupCopyOEMInfA( + __in PCSTR SourceInfFileName, + __in_opt PCSTR OEMSourceMediaLocation, + __in DWORD OEMSourceMediaType, + __in DWORD CopyStyle, + __out_ecount_opt(DestinationInfFileNameSize) PSTR DestinationInfFileName, + __in DWORD DestinationInfFileNameSize, + __out_opt PDWORD RequiredSize, + __out_opt PSTR *DestinationInfFileNameComponent + ); + +WINSETUPAPI +BOOL +WINAPI +SetupCopyOEMInfW( + __in PCWSTR SourceInfFileName, + __in_opt PCWSTR OEMSourceMediaLocation, + __in DWORD OEMSourceMediaType, + __in DWORD CopyStyle, + __out_ecount_opt(DestinationInfFileNameSize) PWSTR DestinationInfFileName, + __in DWORD DestinationInfFileNameSize, + __out_opt PDWORD RequiredSize, + __out_opt PWSTR *DestinationInfFileNameComponent + ); + +#ifdef UNICODE +#define SetupCopyOEMInf SetupCopyOEMInfW +#else +#define SetupCopyOEMInf SetupCopyOEMInfA +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Flags used by SetupUninstallOEMInf +// +#define SUOI_FORCEDELETE 0x00000001 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#define SUOI_INTERNAL1 0x00000002 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP +WINSETUPAPI +BOOL +WINAPI +SetupUninstallOEMInfA( + __in PCSTR InfFileName, + __in DWORD Flags, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupUninstallOEMInfW( + __in PCWSTR InfFileName, + __in DWORD Flags, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupUninstallOEMInf SetupUninstallOEMInfW +#else +#define SetupUninstallOEMInf SetupUninstallOEMInfA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupUninstallNewlyCopiedInfs( + __in HSPFILEQ FileQueue, + __in DWORD Flags, + __reserved PVOID Reserved + ); + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + + +// +// Disk space list APIs +// +WINSETUPAPI +HDSKSPC +WINAPI +SetupCreateDiskSpaceListA( + __reserved PVOID Reserved1, + __reserved DWORD Reserved2, + __in UINT Flags + ); + +WINSETUPAPI +HDSKSPC +WINAPI +SetupCreateDiskSpaceListW( + __reserved PVOID Reserved1, + __reserved DWORD Reserved2, + __in UINT Flags + ); + +#ifdef UNICODE +#define SetupCreateDiskSpaceList SetupCreateDiskSpaceListW +#else +#define SetupCreateDiskSpaceList SetupCreateDiskSpaceListA +#endif + +// +// Flags for SetupCreateDiskSpaceList +// +#define SPDSL_IGNORE_DISK 0x00000001 // ignore deletes and on-disk files in copies +#define SPDSL_DISALLOW_NEGATIVE_ADJUST 0x00000002 + + +WINSETUPAPI +HDSKSPC +WINAPI +SetupDuplicateDiskSpaceListA( + __in HDSKSPC DiskSpace, + __reserved PVOID Reserved1, + __reserved DWORD Reserved2, + __in UINT Flags + ); + +WINSETUPAPI +HDSKSPC +WINAPI +SetupDuplicateDiskSpaceListW( + __in HDSKSPC DiskSpace, + __reserved PVOID Reserved1, + __reserved DWORD Reserved2, + __in UINT Flags + ); + +#ifdef UNICODE +#define SetupDuplicateDiskSpaceList SetupDuplicateDiskSpaceListW +#else +#define SetupDuplicateDiskSpaceList SetupDuplicateDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDestroyDiskSpaceList( + __inout HDSKSPC DiskSpace + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupQueryDrivesInDiskSpaceListA( + __in HDSKSPC DiskSpace, + __out_ecount_opt(ReturnBufferSize) PSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueryDrivesInDiskSpaceListW( + __in HDSKSPC DiskSpace, + __out_ecount_opt(ReturnBufferSize) PWSTR ReturnBuffer, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupQueryDrivesInDiskSpaceList SetupQueryDrivesInDiskSpaceListW +#else +#define SetupQueryDrivesInDiskSpaceList SetupQueryDrivesInDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupQuerySpaceRequiredOnDriveA( + __in HDSKSPC DiskSpace, + __in PCSTR DriveSpec, + __out LONGLONG *SpaceRequired, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQuerySpaceRequiredOnDriveW( + __in HDSKSPC DiskSpace, + __in PCWSTR DriveSpec, + __out LONGLONG *SpaceRequired, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupQuerySpaceRequiredOnDrive SetupQuerySpaceRequiredOnDriveW +#else +#define SetupQuerySpaceRequiredOnDrive SetupQuerySpaceRequiredOnDriveA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupAdjustDiskSpaceListA( + __in HDSKSPC DiskSpace, + __in LPCSTR DriveRoot, + __in LONGLONG Amount, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupAdjustDiskSpaceListW( + __in HDSKSPC DiskSpace, + __in LPCWSTR DriveRoot, + __in LONGLONG Amount, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupAdjustDiskSpaceList SetupAdjustDiskSpaceListW +#else +#define SetupAdjustDiskSpaceList SetupAdjustDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupAddToDiskSpaceListA( + __in HDSKSPC DiskSpace, + __in PCSTR TargetFilespec, + __in LONGLONG FileSize, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupAddToDiskSpaceListW( + __in HDSKSPC DiskSpace, + __in PCWSTR TargetFilespec, + __in LONGLONG FileSize, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupAddToDiskSpaceList SetupAddToDiskSpaceListW +#else +#define SetupAddToDiskSpaceList SetupAddToDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupAddSectionToDiskSpaceListA( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCSTR SectionName, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupAddSectionToDiskSpaceListW( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCWSTR SectionName, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupAddSectionToDiskSpaceList SetupAddSectionToDiskSpaceListW +#else +#define SetupAddSectionToDiskSpaceList SetupAddSectionToDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupAddInstallSectionToDiskSpaceListA( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF LayoutInfHandle, + __in PCSTR SectionName, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupAddInstallSectionToDiskSpaceListW( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF LayoutInfHandle, + __in PCWSTR SectionName, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupAddInstallSectionToDiskSpaceList SetupAddInstallSectionToDiskSpaceListW +#else +#define SetupAddInstallSectionToDiskSpaceList SetupAddInstallSectionToDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveFromDiskSpaceListA( + __in HDSKSPC DiskSpace, + __in PCSTR TargetFilespec, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveFromDiskSpaceListW( + __in HDSKSPC DiskSpace, + __in PCWSTR TargetFilespec, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupRemoveFromDiskSpaceList SetupRemoveFromDiskSpaceListW +#else +#define SetupRemoveFromDiskSpaceList SetupRemoveFromDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveSectionFromDiskSpaceListA( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCSTR SectionName, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveSectionFromDiskSpaceListW( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF ListInfHandle, + __in PCWSTR SectionName, + __in UINT Operation, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupRemoveSectionFromDiskSpaceList SetupRemoveSectionFromDiskSpaceListW +#else +#define SetupRemoveSectionFromDiskSpaceList SetupRemoveSectionFromDiskSpaceListA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveInstallSectionFromDiskSpaceListA( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF LayoutInfHandle, + __in PCSTR SectionName, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveInstallSectionFromDiskSpaceListW( + __in HDSKSPC DiskSpace, + __in HINF InfHandle, + __in_opt HINF LayoutInfHandle, + __in PCWSTR SectionName, + __reserved PVOID Reserved1, + __reserved UINT Reserved2 + ); + +#ifdef UNICODE +#define SetupRemoveInstallSectionFromDiskSpaceList SetupRemoveInstallSectionFromDiskSpaceListW +#else +#define SetupRemoveInstallSectionFromDiskSpaceList SetupRemoveInstallSectionFromDiskSpaceListA +#endif + + +// +// Cabinet APIs +// + +WINSETUPAPI +BOOL +WINAPI +SetupIterateCabinetA( + __in PCSTR CabinetFile, + __reserved DWORD Reserved, + __in PSP_FILE_CALLBACK_A MsgHandler, + __in PVOID Context + ); + +WINSETUPAPI +BOOL +WINAPI +SetupIterateCabinetW( + __in PCWSTR CabinetFile, + __reserved DWORD Reserved, + __in PSP_FILE_CALLBACK_W MsgHandler, + __in PVOID Context + ); + +#ifdef UNICODE +#define SetupIterateCabinet SetupIterateCabinetW +#else +#define SetupIterateCabinet SetupIterateCabinetA +#endif + + +WINSETUPAPI +INT +WINAPI +SetupPromptReboot( + __in_opt HSPFILEQ FileQueue, + __in_opt HWND Owner, + __in BOOL ScanOnly + ); + +// +// Define flags that are returned by SetupPromptReboot +// +#define SPFILEQ_FILE_IN_USE 0x00000001 +#define SPFILEQ_REBOOT_RECOMMENDED 0x00000002 +#define SPFILEQ_REBOOT_IN_PROGRESS 0x00000004 + + +WINSETUPAPI +PVOID +WINAPI +SetupInitDefaultQueueCallback( + __in_opt HWND OwnerWindow + ); + +WINSETUPAPI +PVOID +WINAPI +SetupInitDefaultQueueCallbackEx( + __in_opt HWND OwnerWindow, + __in_opt HWND AlternateProgressWindow, + __in UINT ProgressMessage, + __reserved DWORD Reserved1, + __reserved PVOID Reserved2 + ); + +WINSETUPAPI +VOID +WINAPI +SetupTermDefaultQueueCallback( + __in PVOID Context + ); + +WINSETUPAPI +UINT +WINAPI +SetupDefaultQueueCallbackA( + __in PVOID Context, + __in UINT Notification, + __in UINT_PTR Param1, + __in UINT_PTR Param2 + ); + +WINSETUPAPI +UINT +WINAPI +SetupDefaultQueueCallbackW( + __in PVOID Context, + __in UINT Notification, + __in UINT_PTR Param1, + __in UINT_PTR Param2 + ); + +#ifdef UNICODE +#define SetupDefaultQueueCallback SetupDefaultQueueCallbackW +#else +#define SetupDefaultQueueCallback SetupDefaultQueueCallbackA +#endif + + +// +// Flags for AddReg section lines in INF. The corresponding value +// is in the AddReg line format given below: +// +// ,,,,... +// +// The low word contains basic flags concerning the general data type +// and AddReg action. The high word contains values that more specifically +// identify the data type of the registry value. The high word is ignored +// by the 16-bit Windows 95 SETUPX APIs. +// +// If has FLG_ADDREG_DELREG_BIT set, it will be ignored by AddReg +// (not supported by SetupX). +// + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define FLG_ADDREG_DELREG_BIT ( 0x00008000 ) // if set, interpret as DELREG, see below + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define FLG_ADDREG_BINVALUETYPE ( 0x00000001 ) +#define FLG_ADDREG_NOCLOBBER ( 0x00000002 ) +#define FLG_ADDREG_DELVAL ( 0x00000004 ) +#define FLG_ADDREG_APPEND ( 0x00000008 ) // Currently supported only + // for REG_MULTI_SZ values. +#define FLG_ADDREG_KEYONLY ( 0x00000010 ) // Just create the key, ignore value +#define FLG_ADDREG_OVERWRITEONLY ( 0x00000020 ) // Set only if value already exists + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define FLG_ADDREG_64BITKEY ( 0x00001000 ) // make this change in the 64 bit registry. +#define FLG_ADDREG_KEYONLY_COMMON ( 0x00002000 ) // same as FLG_ADDREG_KEYONLY but also works for DELREG +#define FLG_ADDREG_32BITKEY ( 0x00004000 ) // make this change in the 32 bit registry. + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// The INF may supply any arbitrary data type ordinal in the highword except +// for the following: REG_NONE, REG_SZ, REG_EXPAND_SZ, REG_MULTI_SZ. If this +// technique is used, then the data is given in binary format, one byte per +// field. +// +#define FLG_ADDREG_TYPE_MASK ( 0xFFFF0000 | FLG_ADDREG_BINVALUETYPE ) +#define FLG_ADDREG_TYPE_SZ ( 0x00000000 ) +#define FLG_ADDREG_TYPE_MULTI_SZ ( 0x00010000 ) +#define FLG_ADDREG_TYPE_EXPAND_SZ ( 0x00020000 ) +#define FLG_ADDREG_TYPE_BINARY ( 0x00000000 | FLG_ADDREG_BINVALUETYPE ) +#define FLG_ADDREG_TYPE_DWORD ( 0x00010000 | FLG_ADDREG_BINVALUETYPE ) +#define FLG_ADDREG_TYPE_NONE ( 0x00020000 | FLG_ADDREG_BINVALUETYPE ) + +// +// Flags for DelReg section lines in INF. The corresponding value +// is in the extended DelReg line format given below: +// +// ,,,[,...] +// +// In SetupX and some versions of SetupAPI, will be ignored and will +// be deleted. Use with care. +// +// The bits determined by mask FLG_DELREG_TYPE_MASK indicates type of data expected. +// must have FLG_ADDREG_DELREG_BIT set, otherwise it is ignored and specified +// value will be deleted (allowing an AddReg section to also be used as a DelReg section) +// if is not specified, will be deleted (if specified) otherwise +// will be deleted. +// +// the compatability flag +// +#define FLG_DELREG_VALUE (0x00000000) + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define FLG_DELREG_TYPE_MASK FLG_ADDREG_TYPE_MASK // 0xFFFF0001 +#define FLG_DELREG_TYPE_SZ FLG_ADDREG_TYPE_SZ // 0x00000000 +#define FLG_DELREG_TYPE_MULTI_SZ FLG_ADDREG_TYPE_MULTI_SZ // 0x00010000 +#define FLG_DELREG_TYPE_EXPAND_SZ FLG_ADDREG_TYPE_EXPAND_SZ // 0x00020000 +#define FLG_DELREG_TYPE_BINARY FLG_ADDREG_TYPE_BINARY // 0x00000001 +#define FLG_DELREG_TYPE_DWORD FLG_ADDREG_TYPE_DWORD // 0x00010001 +#define FLG_DELREG_TYPE_NONE FLG_ADDREG_TYPE_NONE // 0x00020001 +#define FLG_DELREG_64BITKEY FLG_ADDREG_64BITKEY // 0x00001000 +#define FLG_DELREG_KEYONLY_COMMON FLG_ADDREG_KEYONLY_COMMON // 0x00002000 +#define FLG_DELREG_32BITKEY FLG_ADDREG_32BITKEY // 0x00004000 + +// +// = FLG_DELREG_MULTI_SZ_DELSTRING +// ,,,0x00018002, +// removes all entries matching (case ignored) from multi-sz registry value +// + +#define FLG_DELREG_OPERATION_MASK (0x000000FE) +#define FLG_DELREG_MULTI_SZ_DELSTRING ( FLG_DELREG_TYPE_MULTI_SZ | FLG_ADDREG_DELREG_BIT | 0x00000002 ) // 0x00018002 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Flags for BitReg section lines in INF. +// +#define FLG_BITREG_CLEARBITS ( 0x00000000 ) +#define FLG_BITREG_SETBITS ( 0x00000001 ) + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define FLG_BITREG_64BITKEY ( 0x00001000 ) +#define FLG_BITREG_32BITKEY ( 0x00004000 ) + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Flags for Ini2Reg section lines in INF. +// +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define FLG_INI2REG_64BITKEY ( 0x00001000 ) +#define FLG_INI2REG_32BITKEY ( 0x00004000 ) + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Flags for RegSvr section lines in INF +// +#define FLG_REGSVR_DLLREGISTER ( 0x00000001 ) +#define FLG_REGSVR_DLLINSTALL ( 0x00000002 ) + +// Flags for RegSvr section lines in INF +// + +#define FLG_PROFITEM_CURRENTUSER ( 0x00000001 ) +#define FLG_PROFITEM_DELETE ( 0x00000002 ) +#define FLG_PROFITEM_GROUP ( 0x00000004 ) +#define FLG_PROFITEM_CSIDL ( 0x00000008 ) + +// +// Flags for AddProperty section lines in the INF +// + +#define FLG_ADDPROPERTY_NOCLOBBER ( 0x00000001 ) +#define FLG_ADDPROPERTY_OVERWRITEONLY ( 0x00000002 ) +#define FLG_ADDPROPERTY_APPEND ( 0x00000004 ) +#define FLG_ADDPROPERTY_OR ( 0x00000008 ) +#define FLG_ADDPROPERTY_AND ( 0x00000010 ) + +// +// Flags for DelProperty section lines in the INF +// + +#define FLG_DELPROPERTY_MULTI_SZ_DELSTRING ( 0x00000001 ) + + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFromInfSectionA( + __in_opt HWND Owner, + __in HINF InfHandle, + __in PCSTR SectionName, + __in UINT Flags, + __in_opt HKEY RelativeKeyRoot, + __in_opt PCSTR SourceRootPath, + __in UINT CopyFlags, + __in_opt PSP_FILE_CALLBACK_A MsgHandler, + __in_opt PVOID Context, + __in_opt HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFromInfSectionW( + __in_opt HWND Owner, + __in HINF InfHandle, + __in PCWSTR SectionName, + __in UINT Flags, + __in_opt HKEY RelativeKeyRoot, + __in_opt PCWSTR SourceRootPath, + __in UINT CopyFlags, + __in_opt PSP_FILE_CALLBACK_W MsgHandler, + __in_opt PVOID Context, + __in_opt HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +#ifdef UNICODE +#define SetupInstallFromInfSection SetupInstallFromInfSectionW +#else +#define SetupInstallFromInfSection SetupInstallFromInfSectionA +#endif + +// +// Flags for SetupInstallFromInfSection +// +#define SPINST_LOGCONFIG 0x00000001 +#define SPINST_INIFILES 0x00000002 +#define SPINST_REGISTRY 0x00000004 +#define SPINST_INI2REG 0x00000008 +#define SPINST_FILES 0x00000010 +#define SPINST_BITREG 0x00000020 +#define SPINST_REGSVR 0x00000040 +#define SPINST_UNREGSVR 0x00000080 +#define SPINST_PROFILEITEMS 0x00000100 + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define SPINST_COPYINF 0x00000200 + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#define SPINST_PROPERTIES 0x00000400 +#define SPINST_ALL 0x000007ff + +#else + +#define SPINST_ALL 0x000003ff + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#else + +#define SPINST_ALL 0x000001ff + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define SPINST_SINGLESECTION 0x00010000 +#define SPINST_LOGCONFIG_IS_FORCED 0x00020000 +#define SPINST_LOGCONFIGS_ARE_OVERRIDES 0x00040000 + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define SPINST_REGISTERCALLBACKAWARE 0x00080000 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#define SPINST_DEVICEINSTALL 0x00100000 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFilesFromInfSectionA( + __in HINF InfHandle, + __in_opt HINF LayoutInfHandle, + __in HSPFILEQ FileQueue, + __in PCSTR SectionName, + __in_opt PCSTR SourceRootPath, + __in UINT CopyFlags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupInstallFilesFromInfSectionW( + __in HINF InfHandle, + __in_opt HINF LayoutInfHandle, + __in HSPFILEQ FileQueue, + __in PCWSTR SectionName, + __in_opt PCWSTR SourceRootPath, + __in UINT CopyFlags + ); + +#ifdef UNICODE +#define SetupInstallFilesFromInfSection SetupInstallFilesFromInfSectionW +#else +#define SetupInstallFilesFromInfSection SetupInstallFilesFromInfSectionA +#endif + + +// +// Flags for SetupInstallServicesFromInfSection(Ex). These flags are also used +// in the flags field of AddService or DelService lines in a device INF. Some +// of these flags are not permitted in the non-Ex API. These flags are marked +// as such below. +// + +// +// (AddService) move service's tag to front of its group order list +// +#define SPSVCINST_TAGTOFRONT (0x00000001) + +// +// (AddService) **Ex API only** mark this service as the function driver for the +// device being installed +// +#define SPSVCINST_ASSOCSERVICE (0x00000002) + +// +// (DelService) delete the associated event log entry for a service specified in +// a DelService entry +// +#define SPSVCINST_DELETEEVENTLOGENTRY (0x00000004) + +// +// (AddService) don't overwrite display name if it already exists +// +#define SPSVCINST_NOCLOBBER_DISPLAYNAME (0x00000008) + +// +// (AddService) don't overwrite start type value if service already exists +// +#define SPSVCINST_NOCLOBBER_STARTTYPE (0x00000010) + +// +// (AddService) don't overwrite error control value if service already exists +// +#define SPSVCINST_NOCLOBBER_ERRORCONTROL (0x00000020) + +// +// (AddService) don't overwrite load order group if it already exists +// +#define SPSVCINST_NOCLOBBER_LOADORDERGROUP (0x00000040) + +// +// (AddService) don't overwrite dependencies list if it already exists +// +#define SPSVCINST_NOCLOBBER_DEPENDENCIES (0x00000080) + +// +// (AddService) don't overwrite description if it already exists +// +#define SPSVCINST_NOCLOBBER_DESCRIPTION (0x00000100) +// +// (DelService) stop the associated service specified in +// a DelService entry before deleting the service +// +#define SPSVCINST_STOPSERVICE (0x00000200) + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP +// +// (AddService) force overwrite of security settings +// +#define SPSVCINST_CLOBBER_SECURITY (0x00000400) + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN +// +// (Start Service) start a service manually after install +// +#define SPSVCINST_STARTSERVICE (0x00000800) + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#if _SETUPAPI_VER >= _WIN32_WINNT_WIN7 +// +// (AddService) don't overwrite required privileges list if it already exists +// +#define SPSVCINST_NOCLOBBER_REQUIREDPRIVILEGES (0x00001000) + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WIN7 + + + +WINSETUPAPI +BOOL +WINAPI +SetupInstallServicesFromInfSectionA( + __in HINF InfHandle, + __in PCSTR SectionName, + __in DWORD Flags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupInstallServicesFromInfSectionW( + __in HINF InfHandle, + __in PCWSTR SectionName, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupInstallServicesFromInfSection SetupInstallServicesFromInfSectionW +#else +#define SetupInstallServicesFromInfSection SetupInstallServicesFromInfSectionA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupInstallServicesFromInfSectionExA( + __in HINF InfHandle, + __in PCSTR SectionName, + __in DWORD Flags, + __in_opt HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __reserved PVOID Reserved1, + __reserved PVOID Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupInstallServicesFromInfSectionExW( + __in HINF InfHandle, + __in PCWSTR SectionName, + __in DWORD Flags, + __in_opt HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __reserved PVOID Reserved1, + __reserved PVOID Reserved2 + ); + +#ifdef UNICODE +#define SetupInstallServicesFromInfSectionEx SetupInstallServicesFromInfSectionExW +#else +#define SetupInstallServicesFromInfSectionEx SetupInstallServicesFromInfSectionExA +#endif + + + +// +// High level routine, usually used via rundll32.dll +// to perform right-click install action on INFs +// May be called directly: +// +// wsprintf(CmdLineBuffer,TEXT("DefaultInstall 132 %s"),InfPath); +// InstallHinfSection(NULL,NULL,CmdLineBuffer,0); +// +VOID +WINAPI +InstallHinfSectionA( + __in HWND Window, + __in HINSTANCE ModuleHandle, + __in PCSTR CommandLine, + __in INT ShowCommand + ); + +VOID +WINAPI +InstallHinfSectionW( + __in HWND Window, + __in HINSTANCE ModuleHandle, + __in PCWSTR CommandLine, + __in INT ShowCommand + ); + +#ifdef UNICODE +#define InstallHinfSection InstallHinfSectionW +#else +#define InstallHinfSection InstallHinfSectionA +#endif + + + + + +// +// Define handle type for Setup file log. +// +typedef PVOID HSPFILELOG; + +WINSETUPAPI +HSPFILELOG +WINAPI +SetupInitializeFileLogA( + __in_opt PCSTR LogFileName, + __in DWORD Flags + ); + +WINSETUPAPI +HSPFILELOG +WINAPI +SetupInitializeFileLogW( + __in_opt PCWSTR LogFileName, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupInitializeFileLog SetupInitializeFileLogW +#else +#define SetupInitializeFileLog SetupInitializeFileLogA +#endif + +// +// Flags for SetupInitializeFileLog +// +#define SPFILELOG_SYSTEMLOG 0x00000001 // use system log -- must be Administrator +#define SPFILELOG_FORCENEW 0x00000002 // not valid with SPFILELOG_SYSTEMLOG +#define SPFILELOG_QUERYONLY 0x00000004 // allows non-administrators to read system log + + +WINSETUPAPI +BOOL +WINAPI +SetupTerminateFileLog( + __in HSPFILELOG FileLogHandle + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupLogFileA( + __in HSPFILELOG FileLogHandle, + __in_opt PCSTR LogSectionName, + __in PCSTR SourceFilename, + __in PCSTR TargetFilename, + __in DWORD Checksum, + __in_opt PCSTR DiskTagfile, + __in_opt PCSTR DiskDescription, + __in_opt PCSTR OtherInfo, + __in DWORD Flags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupLogFileW( + __in HSPFILELOG FileLogHandle, + __in_opt PCWSTR LogSectionName, + __in PCWSTR SourceFilename, + __in PCWSTR TargetFilename, + __in DWORD Checksum, + __in_opt PCWSTR DiskTagfile, + __in_opt PCWSTR DiskDescription, + __in_opt PCWSTR OtherInfo, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupLogFile SetupLogFileW +#else +#define SetupLogFile SetupLogFileA +#endif + +// +// Flags for SetupLogFile +// +#define SPFILELOG_OEMFILE 0x00000001 + + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveFileLogEntryA( + __in HSPFILELOG FileLogHandle, + __in_opt PCSTR LogSectionName, + __in_opt PCSTR TargetFilename + ); + +WINSETUPAPI +BOOL +WINAPI +SetupRemoveFileLogEntryW( + __in HSPFILELOG FileLogHandle, + __in_opt PCWSTR LogSectionName, + __in_opt PCWSTR TargetFilename + ); + +#ifdef UNICODE +#define SetupRemoveFileLogEntry SetupRemoveFileLogEntryW +#else +#define SetupRemoveFileLogEntry SetupRemoveFileLogEntryA +#endif + + +// +// Items retrievable from SetupQueryFileLog() +// +typedef enum { + SetupFileLogSourceFilename, + SetupFileLogChecksum, + SetupFileLogDiskTagfile, + SetupFileLogDiskDescription, + SetupFileLogOtherInfo, + SetupFileLogMax +} SetupFileLogInfo; + +WINSETUPAPI +BOOL +WINAPI +SetupQueryFileLogA( + __in HSPFILELOG FileLogHandle, + __in_opt PCSTR LogSectionName, + __in PCSTR TargetFilename, + __in SetupFileLogInfo DesiredInfo, + __out_ecount_opt(ReturnBufferSize) PSTR DataOut, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupQueryFileLogW( + __in HSPFILELOG FileLogHandle, + __in_opt PCWSTR LogSectionName, + __in PCWSTR TargetFilename, + __in SetupFileLogInfo DesiredInfo, + __out_ecount_opt(ReturnBufferSize) PWSTR DataOut, + __in DWORD ReturnBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupQueryFileLog SetupQueryFileLogW +#else +#define SetupQueryFileLog SetupQueryFileLogA +#endif + +// +// Text logging APIs +// +#define LogSeverity DWORD +#define LogSevInformation 0x00000000 +#define LogSevWarning 0x00000001 +#define LogSevError 0x00000002 +#define LogSevFatalError 0x00000003 +#define LogSevMaximum 0x00000004 + +WINSETUPAPI +BOOL +WINAPI +SetupOpenLog ( + __in BOOL Erase + ); + +WINSETUPAPI +BOOL +WINAPI +SetupLogErrorA ( + __in LPCSTR MessageString, + __in LogSeverity Severity + ); + +WINSETUPAPI +BOOL +WINAPI +SetupLogErrorW ( + __in LPCWSTR MessageString, + __in LogSeverity Severity + ); + +#ifdef UNICODE +#define SetupLogError SetupLogErrorW +#else +#define SetupLogError SetupLogErrorA +#endif + +WINSETUPAPI +VOID +WINAPI +SetupCloseLog ( + VOID + ); + +// +// Text log for INF debugging +// + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +WINSETUPAPI +SP_LOG_TOKEN +WINAPI +SetupGetThreadLogToken( + VOID + ); + +WINSETUPAPI +VOID +WINAPI +SetupSetThreadLogToken( + __in SP_LOG_TOKEN LogToken + ); + +WINSETUPAPI +VOID +WINAPI +SetupWriteTextLog( + __in SP_LOG_TOKEN LogToken, + __in DWORD Category, + __in DWORD Flags, + __in PCSTR MessageStr, + ... + ); + +WINSETUPAPI +VOID +WINAPI +SetupWriteTextLogError( + __in SP_LOG_TOKEN LogToken, + __in DWORD Category, + __in DWORD LogFlags, + __in DWORD Error, + __in PCSTR MessageStr, + ... + ); + +WINSETUPAPI +VOID +WINAPI +SetupWriteTextLogInfLine( + __in SP_LOG_TOKEN LogToken, + __in DWORD Flags, + __in HINF InfHandle, + __in PINFCONTEXT Context + ); + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +// +// Backup Information API's +// + +WINSETUPAPI +BOOL +WINAPI +SetupGetBackupInformationA( + __in HSPFILEQ QueueHandle, + __inout PSP_BACKUP_QUEUE_PARAMS_A BackupParams + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetBackupInformationW( + __in HSPFILEQ QueueHandle, + __inout PSP_BACKUP_QUEUE_PARAMS_W BackupParams + ); + +#ifdef UNICODE +#define SetupGetBackupInformation SetupGetBackupInformationW +#else +#define SetupGetBackupInformation SetupGetBackupInformationA +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupPrepareQueueForRestoreA( + __in HSPFILEQ QueueHandle, + __in PCSTR BackupPath, + __in DWORD RestoreFlags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupPrepareQueueForRestoreW( + __in HSPFILEQ QueueHandle, + __in PCWSTR BackupPath, + __in DWORD RestoreFlags + ); + +#ifdef UNICODE +#define SetupPrepareQueueForRestore SetupPrepareQueueForRestoreW +#else +#define SetupPrepareQueueForRestore SetupPrepareQueueForRestoreA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Control forcing of Non-Interactive Mode +// Overriden if SetupAPI is run in non-interactive window session +// + +WINSETUPAPI +BOOL +WINAPI +SetupSetNonInteractiveMode( + __in BOOL NonInteractiveFlag + ); + +WINSETUPAPI +BOOL +WINAPI +SetupGetNonInteractiveMode( + VOID + ); + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Device Installer APIs +// + +__checkReturn +WINSETUPAPI +HDEVINFO +WINAPI +SetupDiCreateDeviceInfoList( + __in_opt CONST GUID *ClassGuid, + __in_opt HWND hwndParent + ); + + +__checkReturn +WINSETUPAPI +HDEVINFO +WINAPI +SetupDiCreateDeviceInfoListExA( + __in_opt CONST GUID *ClassGuid, + __in_opt HWND hwndParent, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +__checkReturn +WINSETUPAPI +HDEVINFO +WINAPI +SetupDiCreateDeviceInfoListExW( + __in_opt CONST GUID *ClassGuid, + __in_opt HWND hwndParent, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiCreateDeviceInfoListEx SetupDiCreateDeviceInfoListExW +#else +#define SetupDiCreateDeviceInfoListEx SetupDiCreateDeviceInfoListExA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInfoListClass( + __in HDEVINFO DeviceInfoSet, + __out LPGUID ClassGuid + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInfoListDetailA( + __in HDEVINFO DeviceInfoSet, + __out PSP_DEVINFO_LIST_DETAIL_DATA_A DeviceInfoSetDetailData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInfoListDetailW( + __in HDEVINFO DeviceInfoSet, + __out PSP_DEVINFO_LIST_DETAIL_DATA_W DeviceInfoSetDetailData + ); + +#ifdef UNICODE +#define SetupDiGetDeviceInfoListDetail SetupDiGetDeviceInfoListDetailW +#else +#define SetupDiGetDeviceInfoListDetail SetupDiGetDeviceInfoListDetailA +#endif + + +// +// Flags for SetupDiCreateDeviceInfo +// +#define DICD_GENERATE_ID 0x00000001 +#define DICD_INHERIT_CLASSDRVS 0x00000002 + +WINSETUPAPI +BOOL +WINAPI +SetupDiCreateDeviceInfoA( + __in HDEVINFO DeviceInfoSet, + __in PCSTR DeviceName, + __in CONST GUID *ClassGuid, + __in_opt PCSTR DeviceDescription, + __in_opt HWND hwndParent, + __in DWORD CreationFlags, + __out_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiCreateDeviceInfoW( + __in HDEVINFO DeviceInfoSet, + __in PCWSTR DeviceName, + __in CONST GUID *ClassGuid, + __in_opt PCWSTR DeviceDescription, + __in_opt HWND hwndParent, + __in DWORD CreationFlags, + __out_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +#ifdef UNICODE +#define SetupDiCreateDeviceInfo SetupDiCreateDeviceInfoW +#else +#define SetupDiCreateDeviceInfo SetupDiCreateDeviceInfoA +#endif + + +// +// Flags for SetupDiOpenDeviceInfo +// +#define DIOD_INHERIT_CLASSDRVS 0x00000002 +#define DIOD_CANCEL_REMOVE 0x00000004 + +WINSETUPAPI +BOOL +WINAPI +SetupDiOpenDeviceInfoA( + __in HDEVINFO DeviceInfoSet, + __in PCSTR DeviceInstanceId, + __in_opt HWND hwndParent, + __in DWORD OpenFlags, + __out_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiOpenDeviceInfoW( + __in HDEVINFO DeviceInfoSet, + __in PCWSTR DeviceInstanceId, + __in_opt HWND hwndParent, + __in DWORD OpenFlags, + __out_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +#ifdef UNICODE +#define SetupDiOpenDeviceInfo SetupDiOpenDeviceInfoW +#else +#define SetupDiOpenDeviceInfo SetupDiOpenDeviceInfoA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInstanceIdA( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __out_ecount_opt(DeviceInstanceIdSize) PSTR DeviceInstanceId, + __in DWORD DeviceInstanceIdSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInstanceIdW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __out_ecount_opt(DeviceInstanceIdSize) PWSTR DeviceInstanceId, + __in DWORD DeviceInstanceIdSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetDeviceInstanceId SetupDiGetDeviceInstanceIdW +#else +#define SetupDiGetDeviceInstanceId SetupDiGetDeviceInstanceIdA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiDeleteDeviceInfo( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiEnumDeviceInfo( + __in HDEVINFO DeviceInfoSet, + __in DWORD MemberIndex, + __out PSP_DEVINFO_DATA DeviceInfoData + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiDestroyDeviceInfoList( + __in HDEVINFO DeviceInfoSet + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiEnumDeviceInterfaces( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in CONST GUID *InterfaceClassGuid, + __in DWORD MemberIndex, + __out PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData + ); + +// +// Backward compatibility--do not use +// +#define SetupDiEnumInterfaceDevice SetupDiEnumDeviceInterfaces + + +WINSETUPAPI +BOOL +WINAPI +SetupDiCreateDeviceInterfaceA( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in CONST GUID *InterfaceClassGuid, + __in_opt PCSTR ReferenceString, + __in DWORD CreationFlags, + __out_opt PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiCreateDeviceInterfaceW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in CONST GUID *InterfaceClassGuid, + __in_opt PCWSTR ReferenceString, + __in DWORD CreationFlags, + __out_opt PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData + ); + +#ifdef UNICODE +#define SetupDiCreateDeviceInterface SetupDiCreateDeviceInterfaceW +#else +#define SetupDiCreateDeviceInterface SetupDiCreateDeviceInterfaceA +#endif + +// +// Backward compatibility--do not use. +// +#define SetupDiCreateInterfaceDeviceW SetupDiCreateDeviceInterfaceW +#define SetupDiCreateInterfaceDeviceA SetupDiCreateDeviceInterfaceA +#ifdef UNICODE +#define SetupDiCreateInterfaceDevice SetupDiCreateDeviceInterfaceW +#else +#define SetupDiCreateInterfaceDevice SetupDiCreateDeviceInterfaceA +#endif + + +// +// Flags for SetupDiOpenDeviceInterface +// +#define DIODI_NO_ADD 0x00000001 + +WINSETUPAPI +BOOL +WINAPI +SetupDiOpenDeviceInterfaceA( + __in HDEVINFO DeviceInfoSet, + __in PCSTR DevicePath, + __in DWORD OpenFlags, + __out_opt PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiOpenDeviceInterfaceW( + __in HDEVINFO DeviceInfoSet, + __in PCWSTR DevicePath, + __in DWORD OpenFlags, + __out_opt PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData + ); + +#ifdef UNICODE +#define SetupDiOpenDeviceInterface SetupDiOpenDeviceInterfaceW +#else +#define SetupDiOpenDeviceInterface SetupDiOpenDeviceInterfaceA +#endif + +// +// Backward compatibility--do not use +// +#define SetupDiOpenInterfaceDeviceW SetupDiOpenDeviceInterfaceW +#define SetupDiOpenInterfaceDeviceA SetupDiOpenDeviceInterfaceA +#ifdef UNICODE +#define SetupDiOpenInterfaceDevice SetupDiOpenDeviceInterfaceW +#else +#define SetupDiOpenInterfaceDevice SetupDiOpenDeviceInterfaceA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInterfaceAlias( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __in CONST GUID *AliasInterfaceClassGuid, + __out PSP_DEVICE_INTERFACE_DATA AliasDeviceInterfaceData + ); + +// +// Backward compatibility--do not use. +// +#define SetupDiGetInterfaceDeviceAlias SetupDiGetDeviceInterfaceAlias + + +WINSETUPAPI +BOOL +WINAPI +SetupDiDeleteDeviceInterfaceData( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData + ); + +// +// Backward compatibility--do not use. +// +#define SetupDiDeleteInterfaceDeviceData SetupDiDeleteDeviceInterfaceData + + +WINSETUPAPI +BOOL +WINAPI +SetupDiRemoveDeviceInterface( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData + ); + +// +// Backward compatibility--do not use. +// +#define SetupDiRemoveInterfaceDevice SetupDiRemoveDeviceInterface + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInterfaceDetailA( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __inout_bcount_opt(DeviceInterfaceDetailDataSize) PSP_DEVICE_INTERFACE_DETAIL_DATA_A DeviceInterfaceDetailData, + __in DWORD DeviceInterfaceDetailDataSize, + __out_opt PDWORD RequiredSize, + __out_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInterfaceDetailW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __out_bcount_opt(DeviceInterfaceDetailDataSize) PSP_DEVICE_INTERFACE_DETAIL_DATA_W DeviceInterfaceDetailData, + __in DWORD DeviceInterfaceDetailDataSize, + __out_opt PDWORD RequiredSize, + __out_opt PSP_DEVINFO_DATA DeviceInfoData + ); + +#ifdef UNICODE +#define SetupDiGetDeviceInterfaceDetail SetupDiGetDeviceInterfaceDetailW +#else +#define SetupDiGetDeviceInterfaceDetail SetupDiGetDeviceInterfaceDetailA +#endif + +// +// Backward compatibility--do not use. +// +#define SetupDiGetInterfaceDeviceDetailW SetupDiGetDeviceInterfaceDetailW +#define SetupDiGetInterfaceDeviceDetailA SetupDiGetDeviceInterfaceDetailA +#ifdef UNICODE +#define SetupDiGetInterfaceDeviceDetail SetupDiGetDeviceInterfaceDetailW +#else +#define SetupDiGetInterfaceDeviceDetail SetupDiGetDeviceInterfaceDetailA +#endif + + +// +// Default install handler for DIF_INSTALLINTERFACES. +// +WINSETUPAPI +BOOL +WINAPI +SetupDiInstallDeviceInterfaces( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData + ); + +// +// Backward compatibility--do not use. +// +#define SetupDiInstallInterfaceDevices SetupDiInstallDeviceInterfaces + + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDeviceInterfaceDefault( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __in DWORD Flags, + __reserved PVOID Reserved + ); + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + + +// +// Default install handler for DIF_REGISTERDEVICE +// + +// +// Flags for SetupDiRegisterDeviceInfo +// +#define SPRDI_FIND_DUPS 0x00000001 + +WINSETUPAPI +BOOL +WINAPI +SetupDiRegisterDeviceInfo( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Flags, + __in_opt PSP_DETSIG_CMPPROC CompareProc, + __in_opt PVOID CompareContext, + __out_opt PSP_DEVINFO_DATA DupDeviceInfoData + ); + + +// +// Ordinal values distinguishing between class drivers and +// device drivers. +// (Passed in 'DriverType' parameter of driver information list APIs) +// +#define SPDIT_NODRIVER 0x00000000 +#define SPDIT_CLASSDRIVER 0x00000001 +#define SPDIT_COMPATDRIVER 0x00000002 + +WINSETUPAPI +BOOL +WINAPI +SetupDiBuildDriverInfoList( + __in HDEVINFO DeviceInfoSet, + __inout_opt PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD DriverType + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiCancelDriverInfoSearch( + __in HDEVINFO DeviceInfoSet + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiEnumDriverInfoA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD DriverType, + __in DWORD MemberIndex, + __out PSP_DRVINFO_DATA_A DriverInfoData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiEnumDriverInfoW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD DriverType, + __in DWORD MemberIndex, + __out PSP_DRVINFO_DATA_W DriverInfoData + ); + +#ifdef UNICODE +#define SetupDiEnumDriverInfo SetupDiEnumDriverInfoW +#else +#define SetupDiEnumDriverInfo SetupDiEnumDriverInfoA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetSelectedDriverA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __out PSP_DRVINFO_DATA_A DriverInfoData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetSelectedDriverW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __out PSP_DRVINFO_DATA_W DriverInfoData + ); + +#ifdef UNICODE +#define SetupDiGetSelectedDriver SetupDiGetSelectedDriverW +#else +#define SetupDiGetSelectedDriver SetupDiGetSelectedDriverA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetSelectedDriverA( + __in HDEVINFO DeviceInfoSet, + __inout_opt PSP_DEVINFO_DATA DeviceInfoData, + __inout_opt PSP_DRVINFO_DATA_A DriverInfoData + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetSelectedDriverW( + __in HDEVINFO DeviceInfoSet, + __inout_opt PSP_DEVINFO_DATA DeviceInfoData, + __inout_opt PSP_DRVINFO_DATA_W DriverInfoData + ); + +#ifdef UNICODE +#define SetupDiSetSelectedDriver SetupDiSetSelectedDriverW +#else +#define SetupDiSetSelectedDriver SetupDiSetSelectedDriverA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDriverInfoDetailA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DRVINFO_DATA_A DriverInfoData, + __inout_bcount_opt(DriverInfoDetailDataSize) PSP_DRVINFO_DETAIL_DATA_A DriverInfoDetailData, + __in DWORD DriverInfoDetailDataSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDriverInfoDetailW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DRVINFO_DATA_W DriverInfoData, + __inout_bcount_opt(DriverInfoDetailDataSize) PSP_DRVINFO_DETAIL_DATA_W DriverInfoDetailData, + __in DWORD DriverInfoDetailDataSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetDriverInfoDetail SetupDiGetDriverInfoDetailW +#else +#define SetupDiGetDriverInfoDetail SetupDiGetDriverInfoDetailA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiDestroyDriverInfoList( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD DriverType + ); + + +// +// Flags controlling what is included in the device information set built +// by SetupDiGetClassDevs +// +#define DIGCF_DEFAULT 0x00000001 // only valid with DIGCF_DEVICEINTERFACE +#define DIGCF_PRESENT 0x00000002 +#define DIGCF_ALLCLASSES 0x00000004 +#define DIGCF_PROFILE 0x00000008 +#define DIGCF_DEVICEINTERFACE 0x00000010 + +// +// Backward compatibility--do not use. +// +#define DIGCF_INTERFACEDEVICE DIGCF_DEVICEINTERFACE + + +__checkReturn +WINSETUPAPI +HDEVINFO +WINAPI +SetupDiGetClassDevsA( + __in_opt CONST GUID *ClassGuid, + __in_opt PCSTR Enumerator, + __in_opt HWND hwndParent, + __in DWORD Flags + ); + +__checkReturn +WINSETUPAPI +HDEVINFO +WINAPI +SetupDiGetClassDevsW( + __in_opt CONST GUID *ClassGuid, + __in_opt PCWSTR Enumerator, + __in_opt HWND hwndParent, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupDiGetClassDevs SetupDiGetClassDevsW +#else +#define SetupDiGetClassDevs SetupDiGetClassDevsA +#endif + + +__checkReturn +WINSETUPAPI +HDEVINFO +WINAPI +SetupDiGetClassDevsExA( + __in_opt CONST GUID *ClassGuid, + __in_opt PCSTR Enumerator, + __in_opt HWND hwndParent, + __in DWORD Flags, + __in_opt HDEVINFO DeviceInfoSet, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +__checkReturn +WINSETUPAPI +HDEVINFO +WINAPI +SetupDiGetClassDevsExW( + __in_opt CONST GUID *ClassGuid, + __in_opt PCWSTR Enumerator, + __in_opt HWND hwndParent, + __in DWORD Flags, + __in_opt HDEVINFO DeviceInfoSet, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetClassDevsEx SetupDiGetClassDevsExW +#else +#define SetupDiGetClassDevsEx SetupDiGetClassDevsExA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetINFClassA( + __in PCSTR InfName, + __out LPGUID ClassGuid, + __out_ecount(ClassNameSize) PSTR ClassName, + __in DWORD ClassNameSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetINFClassW( + __in PCWSTR InfName, + __out LPGUID ClassGuid, + __out_ecount(ClassNameSize) PWSTR ClassName, + __in DWORD ClassNameSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetINFClass SetupDiGetINFClassW +#else +#define SetupDiGetINFClass SetupDiGetINFClassA +#endif + + +// +// Flags controlling exclusion from the class information list built +// by SetupDiBuildClassInfoList(Ex) +// +#define DIBCI_NOINSTALLCLASS 0x00000001 +#define DIBCI_NODISPLAYCLASS 0x00000002 + +WINSETUPAPI +BOOL +WINAPI +SetupDiBuildClassInfoList( + __in DWORD Flags, + __out_ecount_opt(ClassGuidListSize) LPGUID ClassGuidList, + __in DWORD ClassGuidListSize, + __out PDWORD RequiredSize + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiBuildClassInfoListExA( + __in DWORD Flags, + __out_ecount_opt(ClassGuidListSize) LPGUID ClassGuidList, + __in DWORD ClassGuidListSize, + __out PDWORD RequiredSize, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiBuildClassInfoListExW( + __in DWORD Flags, + __out_ecount_opt(ClassGuidListSize) LPGUID ClassGuidList, + __in DWORD ClassGuidListSize, + __out PDWORD RequiredSize, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiBuildClassInfoListEx SetupDiBuildClassInfoListExW +#else +#define SetupDiBuildClassInfoListEx SetupDiBuildClassInfoListExA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassDescriptionA( + __in CONST GUID *ClassGuid, + __out_ecount(ClassDescriptionSize) PSTR ClassDescription, + __in DWORD ClassDescriptionSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassDescriptionW( + __in CONST GUID *ClassGuid, + __out_ecount(ClassDescriptionSize) PWSTR ClassDescription, + __in DWORD ClassDescriptionSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetClassDescription SetupDiGetClassDescriptionW +#else +#define SetupDiGetClassDescription SetupDiGetClassDescriptionA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassDescriptionExA( + __in CONST GUID *ClassGuid, + __out_ecount(ClassDescriptionSize) PSTR ClassDescription, + __in DWORD ClassDescriptionSize, + __out_opt PDWORD RequiredSize, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassDescriptionExW( + __in CONST GUID *ClassGuid, + __out_ecount(ClassDescriptionSize) PWSTR ClassDescription, + __in DWORD ClassDescriptionSize, + __out_opt PDWORD RequiredSize, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetClassDescriptionEx SetupDiGetClassDescriptionExW +#else +#define SetupDiGetClassDescriptionEx SetupDiGetClassDescriptionExA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiCallClassInstaller( + __in DI_FUNCTION InstallFunction, + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData + ); + + +// +// Default install handler for DIF_SELECTDEVICE +// +WINSETUPAPI +BOOL +WINAPI +SetupDiSelectDevice( + __in HDEVINFO DeviceInfoSet, + __inout_opt PSP_DEVINFO_DATA DeviceInfoData + ); + + +// +// Default install handler for DIF_SELECTBESTCOMPATDRV +// +WINSETUPAPI +BOOL +WINAPI +SetupDiSelectBestCompatDrv( + __in HDEVINFO DeviceInfoSet, + __inout_opt PSP_DEVINFO_DATA DeviceInfoData + ); + + +// +// Default install handler for DIF_INSTALLDEVICE +// +WINSETUPAPI +BOOL +WINAPI +SetupDiInstallDevice( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData + ); + + +// +// Default install handler for DIF_INSTALLDEVICEFILES +// +WINSETUPAPI +BOOL +WINAPI +SetupDiInstallDriverFiles( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData + ); + + +// +// Default install handler for DIF_REGISTER_COINSTALLERS +// +WINSETUPAPI +BOOL +WINAPI +SetupDiRegisterCoDeviceInstallers( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData + ); + + +// +// Default install handler for DIF_REMOVE +// +WINSETUPAPI +BOOL +WINAPI +SetupDiRemoveDevice( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData + ); + + +// +// Default install handler for DIF_UNREMOVE +// +WINSETUPAPI +BOOL +WINAPI +SetupDiUnremoveDevice( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData + ); + +#if _SETUPAPI_VER >= _WIN32_WINNT_WS03 + +WINSETUPAPI +BOOL +WINAPI +SetupDiRestartDevices( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData + ); + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WS03 + +// +// Default install handler for DIF_PROPERTYCHANGE +// +WINSETUPAPI +BOOL +WINAPI +SetupDiChangeState( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData + ); + + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +// +// Default install handler for DIF_FINISHINSTALL_ACTION +// +WINSETUPAPI +BOOL +WINAPI +SetupDiFinishInstallAction( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData + ); + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +WINSETUPAPI +BOOL +WINAPI +SetupDiInstallClassA( + __in_opt HWND hwndParent, + __in PCSTR InfFileName, + __in DWORD Flags, + __in_opt HSPFILEQ FileQueue + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiInstallClassW( + __in_opt HWND hwndParent, + __in PCWSTR InfFileName, + __in DWORD Flags, + __in_opt HSPFILEQ FileQueue + ); + +#ifdef UNICODE +#define SetupDiInstallClass SetupDiInstallClassW +#else +#define SetupDiInstallClass SetupDiInstallClassA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiInstallClassExA( + __in_opt HWND hwndParent, + __in_opt PCSTR InfFileName, + __in DWORD Flags, + __in_opt HSPFILEQ FileQueue, + __in_opt CONST GUID *InterfaceClassGuid, + __reserved PVOID Reserved1, + __reserved PVOID Reserved2 + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiInstallClassExW( + __in_opt HWND hwndParent, + __in_opt PCWSTR InfFileName, + __in DWORD Flags, + __in_opt HSPFILEQ FileQueue, + __in_opt CONST GUID *InterfaceClassGuid, + __reserved PVOID Reserved1, + __reserved PVOID Reserved2 + ); + +#ifdef UNICODE +#define SetupDiInstallClassEx SetupDiInstallClassExW +#else +#define SetupDiInstallClassEx SetupDiInstallClassExA +#endif + + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiOpenClassRegKey( + __in_opt CONST GUID *ClassGuid, + __in REGSAM samDesired + ); + + +// +// Flags for SetupDiOpenClassRegKeyEx +// +#define DIOCR_INSTALLER 0x00000001 // class installer registry branch +#define DIOCR_INTERFACE 0x00000002 // interface class registry branch + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiOpenClassRegKeyExA( + __in_opt CONST GUID *ClassGuid, + __in REGSAM samDesired, + __in DWORD Flags, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiOpenClassRegKeyExW( + __in_opt CONST GUID *ClassGuid, + __in REGSAM samDesired, + __in DWORD Flags, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiOpenClassRegKeyEx SetupDiOpenClassRegKeyExW +#else +#define SetupDiOpenClassRegKeyEx SetupDiOpenClassRegKeyExA +#endif + + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiCreateDeviceInterfaceRegKeyA( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __reserved DWORD Reserved, + __in REGSAM samDesired, + __in_opt HINF InfHandle, + __in_opt PCSTR InfSectionName + ); + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiCreateDeviceInterfaceRegKeyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __reserved DWORD Reserved, + __in REGSAM samDesired, + __in_opt HINF InfHandle, + __in_opt PCWSTR InfSectionName + ); + +#ifdef UNICODE +#define SetupDiCreateDeviceInterfaceRegKey SetupDiCreateDeviceInterfaceRegKeyW +#else +#define SetupDiCreateDeviceInterfaceRegKey SetupDiCreateDeviceInterfaceRegKeyA +#endif + +// +// Backward compatibility--do not use. +// +#define SetupDiCreateInterfaceDeviceRegKeyW SetupDiCreateDeviceInterfaceRegKeyW +#define SetupDiCreateInterfaceDeviceRegKeyA SetupDiCreateDeviceInterfaceRegKeyA +#ifdef UNICODE +#define SetupDiCreateInterfaceDeviceRegKey SetupDiCreateDeviceInterfaceRegKeyW +#else +#define SetupDiCreateInterfaceDeviceRegKey SetupDiCreateDeviceInterfaceRegKeyA +#endif + + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiOpenDeviceInterfaceRegKey( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __reserved DWORD Reserved, + __in REGSAM samDesired + ); + +// +// Backward compatibility--do not use. +// +#define SetupDiOpenInterfaceDeviceRegKey SetupDiOpenDeviceInterfaceRegKey + + +WINSETUPAPI +BOOL +WINAPI +SetupDiDeleteDeviceInterfaceRegKey( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __reserved DWORD Reserved + ); + +// +// Backward compatibility--do not use. +// +#define SetupDiDeleteInterfaceDeviceRegKey SetupDiDeleteDeviceInterfaceRegKey + + +// +// KeyType values for SetupDiCreateDevRegKey, SetupDiOpenDevRegKey, and +// SetupDiDeleteDevRegKey. +// +#define DIREG_DEV 0x00000001 // Open/Create/Delete device key +#define DIREG_DRV 0x00000002 // Open/Create/Delete driver key +#define DIREG_BOTH 0x00000004 // Delete both driver and Device key + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiCreateDevRegKeyA( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Scope, + __in DWORD HwProfile, + __in DWORD KeyType, + __in_opt HINF InfHandle, + __in_opt PCSTR InfSectionName + ); + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiCreateDevRegKeyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Scope, + __in DWORD HwProfile, + __in DWORD KeyType, + __in_opt HINF InfHandle, + __in_opt PCWSTR InfSectionName + ); + +#ifdef UNICODE +#define SetupDiCreateDevRegKey SetupDiCreateDevRegKeyW +#else +#define SetupDiCreateDevRegKey SetupDiCreateDevRegKeyA +#endif + + +__checkReturn +WINSETUPAPI +HKEY +WINAPI +SetupDiOpenDevRegKey( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Scope, + __in DWORD HwProfile, + __in DWORD KeyType, + __in REGSAM samDesired + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiDeleteDevRegKey( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Scope, + __in DWORD HwProfile, + __in DWORD KeyType + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetHwProfileList( + __out_ecount(HwProfileListSize) PDWORD HwProfileList, + __in DWORD HwProfileListSize, + __out PDWORD RequiredSize, + __out_opt PDWORD CurrentlyActiveIndex + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetHwProfileListExA( + __out_ecount(HwProfileListSize) PDWORD HwProfileList, + __in DWORD HwProfileListSize, + __out PDWORD RequiredSize, + __out_opt PDWORD CurrentlyActiveIndex, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetHwProfileListExW( + __out_ecount(HwProfileListSize) PDWORD HwProfileList, + __in DWORD HwProfileListSize, + __out PDWORD RequiredSize, + __out_opt PDWORD CurrentlyActiveIndex, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetHwProfileListEx SetupDiGetHwProfileListExW +#else +#define SetupDiGetHwProfileListEx SetupDiGetHwProfileListExA +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDevicePropertyKeys( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __out_ecount_opt(PropertyKeyCount) DEVPROPKEY *PropertyKeyArray, + __in DWORD PropertyKeyCount, + __out_opt PDWORD RequiredPropertyKeyCount, + __in DWORD Flags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDevicePropertyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in CONST DEVPROPKEY *PropertyKey, + __out DEVPROPTYPE *PropertyType, + __out_bcount_opt(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupDiGetDeviceProperty SetupDiGetDevicePropertyW +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDevicePropertyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in CONST DEVPROPKEY *PropertyKey, + __in DEVPROPTYPE PropertyType, + __in_bcount_opt(PropertyBufferSize) CONST PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupDiSetDeviceProperty SetupDiSetDevicePropertyW +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInterfacePropertyKeys( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __out_ecount_opt(PropertyKeyCount) DEVPROPKEY *PropertyKeyArray, + __in DWORD PropertyKeyCount, + __out_opt PDWORD RequiredPropertyKeyCount, + __in DWORD Flags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInterfacePropertyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __in CONST DEVPROPKEY *PropertyKey, + __out DEVPROPTYPE *PropertyType, + __out_bcount_opt(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupDiGetDeviceInterfaceProperty SetupDiGetDeviceInterfacePropertyW +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDeviceInterfacePropertyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData, + __in CONST DEVPROPKEY *PropertyKey, + __in DEVPROPTYPE PropertyType, + __in_bcount_opt(PropertyBufferSize) CONST PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupDiSetDeviceInterfaceProperty SetupDiSetDeviceInterfacePropertyW +#endif + +// +// Flags for SetupDiGetClassPropertyKeys, SetupDiGetClassProperty, and +// SetupDiSetClassProperty. +// +#define DICLASSPROP_INSTALLER 0x00000001 // device setup class property +#define DICLASSPROP_INTERFACE 0x00000002 // device interface class property + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassPropertyKeys( + __in CONST GUID *ClassGuid, + __out_ecount_opt(PropertyKeyCount) DEVPROPKEY *PropertyKeyArray, + __in DWORD PropertyKeyCount, + __out_opt PDWORD RequiredPropertyKeyCount, + __in DWORD Flags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassPropertyKeysExW( + __in CONST GUID *ClassGuid, + __out_ecount_opt(PropertyKeyCount) DEVPROPKEY *PropertyKeyArray, + __in DWORD PropertyKeyCount, + __out_opt PDWORD RequiredPropertyKeyCount, + __in DWORD Flags, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetClassPropertyKeysEx SetupDiGetClassPropertyKeysExW +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassPropertyW( + __in CONST GUID *ClassGuid, + __in CONST DEVPROPKEY *PropertyKey, + __out DEVPROPTYPE *PropertyType, + __out_bcount_opt(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupDiGetClassProperty SetupDiGetClassPropertyW +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassPropertyExW( + __in CONST GUID *ClassGuid, + __in CONST DEVPROPKEY *PropertyKey, + __out DEVPROPTYPE *PropertyType, + __out_bcount_opt(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize, + __in DWORD Flags, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetClassPropertyEx SetupDiGetClassPropertyExW +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetClassPropertyW( + __in CONST GUID *ClassGuid, + __in CONST DEVPROPKEY *PropertyKey, + __in DEVPROPTYPE PropertyType, + __in_bcount_opt(PropertyBufferSize) CONST PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupDiSetClassProperty SetupDiSetClassPropertyW +#endif + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetClassPropertyExW( + __in CONST GUID *ClassGuid, + __in CONST DEVPROPKEY *PropertyKey, + __in DEVPROPTYPE PropertyType, + __in_bcount_opt(PropertyBufferSize) CONST PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __in DWORD Flags, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiSetClassPropertyEx SetupDiSetClassPropertyExW +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +// +// Device registry property codes +// (Codes marked as read-only (R) may only be used for +// SetupDiGetDeviceRegistryProperty) +// +// These values should cover the same set of registry properties +// as defined by the CM_DRP codes in cfgmgr32.h. +// +// Note that SPDRP codes are zero based while CM_DRP codes are one based! +// +#define SPDRP_DEVICEDESC (0x00000000) // DeviceDesc (R/W) +#define SPDRP_HARDWAREID (0x00000001) // HardwareID (R/W) +#define SPDRP_COMPATIBLEIDS (0x00000002) // CompatibleIDs (R/W) +#define SPDRP_UNUSED0 (0x00000003) // unused +#define SPDRP_SERVICE (0x00000004) // Service (R/W) +#define SPDRP_UNUSED1 (0x00000005) // unused +#define SPDRP_UNUSED2 (0x00000006) // unused +#define SPDRP_CLASS (0x00000007) // Class (R--tied to ClassGUID) +#define SPDRP_CLASSGUID (0x00000008) // ClassGUID (R/W) +#define SPDRP_DRIVER (0x00000009) // Driver (R/W) +#define SPDRP_CONFIGFLAGS (0x0000000A) // ConfigFlags (R/W) +#define SPDRP_MFG (0x0000000B) // Mfg (R/W) +#define SPDRP_FRIENDLYNAME (0x0000000C) // FriendlyName (R/W) +#define SPDRP_LOCATION_INFORMATION (0x0000000D) // LocationInformation (R/W) +#define SPDRP_PHYSICAL_DEVICE_OBJECT_NAME (0x0000000E) // PhysicalDeviceObjectName (R) +#define SPDRP_CAPABILITIES (0x0000000F) // Capabilities (R) +#define SPDRP_UI_NUMBER (0x00000010) // UiNumber (R) +#define SPDRP_UPPERFILTERS (0x00000011) // UpperFilters (R/W) +#define SPDRP_LOWERFILTERS (0x00000012) // LowerFilters (R/W) +#define SPDRP_BUSTYPEGUID (0x00000013) // BusTypeGUID (R) +#define SPDRP_LEGACYBUSTYPE (0x00000014) // LegacyBusType (R) +#define SPDRP_BUSNUMBER (0x00000015) // BusNumber (R) +#define SPDRP_ENUMERATOR_NAME (0x00000016) // Enumerator Name (R) +#define SPDRP_SECURITY (0x00000017) // Security (R/W, binary form) +#define SPDRP_SECURITY_SDS (0x00000018) // Security (W, SDS form) +#define SPDRP_DEVTYPE (0x00000019) // Device Type (R/W) +#define SPDRP_EXCLUSIVE (0x0000001A) // Device is exclusive-access (R/W) +#define SPDRP_CHARACTERISTICS (0x0000001B) // Device Characteristics (R/W) +#define SPDRP_ADDRESS (0x0000001C) // Device Address (R) +#define SPDRP_UI_NUMBER_DESC_FORMAT (0X0000001D) // UiNumberDescFormat (R/W) +#define SPDRP_DEVICE_POWER_DATA (0x0000001E) // Device Power Data (R) +#define SPDRP_REMOVAL_POLICY (0x0000001F) // Removal Policy (R) +#define SPDRP_REMOVAL_POLICY_HW_DEFAULT (0x00000020) // Hardware Removal Policy (R) +#define SPDRP_REMOVAL_POLICY_OVERRIDE (0x00000021) // Removal Policy Override (RW) +#define SPDRP_INSTALL_STATE (0x00000022) // Device Install State (R) +#define SPDRP_LOCATION_PATHS (0x00000023) // Device Location Paths (R) +#define SPDRP_BASE_CONTAINERID (0x00000024) // Base ContainerID (R) + +#define SPDRP_MAXIMUM_PROPERTY (0x00000025) // Upper bound on ordinals + +// +// Class registry property codes +// (Codes marked as read-only (R) may only be used for +// SetupDiGetClassRegistryProperty) +// +// These values should cover the same set of registry properties +// as defined by the CM_CRP codes in cfgmgr32.h. +// they should also have a 1:1 correspondence with Device registers, where applicable +// but no overlap otherwise +// +#define SPCRP_UPPERFILTERS (0x00000011) // UpperFilters (R/W) +#define SPCRP_LOWERFILTERS (0x00000012) // LowerFilters (R/W) +#define SPCRP_SECURITY (0x00000017) // Security (R/W, binary form) +#define SPCRP_SECURITY_SDS (0x00000018) // Security (W, SDS form) +#define SPCRP_DEVTYPE (0x00000019) // Device Type (R/W) +#define SPCRP_EXCLUSIVE (0x0000001A) // Device is exclusive-access (R/W) +#define SPCRP_CHARACTERISTICS (0x0000001B) // Device Characteristics (R/W) +#define SPCRP_MAXIMUM_PROPERTY (0x0000001C) // Upper bound on ordinals + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceRegistryPropertyA( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Property, + __out_opt PDWORD PropertyRegDataType, + __out_bcount_opt(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceRegistryPropertyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Property, + __out_opt PDWORD PropertyRegDataType, + __out_bcount_opt(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetDeviceRegistryProperty SetupDiGetDeviceRegistryPropertyW +#else +#define SetupDiGetDeviceRegistryProperty SetupDiGetDeviceRegistryPropertyA +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassRegistryPropertyA( + __in CONST GUID *ClassGuid, + __in DWORD Property, + __out_opt PDWORD PropertyRegDataType, + __out_bcount(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassRegistryPropertyW( + __in CONST GUID *ClassGuid, + __in DWORD Property, + __out_opt PDWORD PropertyRegDataType, + __out_bcount(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetClassRegistryProperty SetupDiGetClassRegistryPropertyW +#else +#define SetupDiGetClassRegistryProperty SetupDiGetClassRegistryPropertyA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDeviceRegistryPropertyA( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Property, + __in_bcount_opt(PropertyBufferSize) CONST BYTE *PropertyBuffer, + __in DWORD PropertyBufferSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDeviceRegistryPropertyW( + __in HDEVINFO DeviceInfoSet, + __inout PSP_DEVINFO_DATA DeviceInfoData, + __in DWORD Property, + __in_bcount_opt(PropertyBufferSize) CONST BYTE *PropertyBuffer, + __in DWORD PropertyBufferSize + ); + +#ifdef UNICODE +#define SetupDiSetDeviceRegistryProperty SetupDiSetDeviceRegistryPropertyW +#else +#define SetupDiSetDeviceRegistryProperty SetupDiSetDeviceRegistryPropertyA +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetClassRegistryPropertyA( + __in CONST GUID *ClassGuid, + __in DWORD Property, + __in_bcount_opt(PropertyBufferSize) CONST BYTE *PropertyBuffer, + __in DWORD PropertyBufferSize, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetClassRegistryPropertyW( + __in CONST GUID *ClassGuid, + __in DWORD Property, + __in_bcount_opt(PropertyBufferSize) CONST BYTE *PropertyBuffer, + __in DWORD PropertyBufferSize, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiSetClassRegistryProperty SetupDiSetClassRegistryPropertyW +#else +#define SetupDiSetClassRegistryProperty SetupDiSetClassRegistryPropertyA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInstallParamsA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __out PSP_DEVINSTALL_PARAMS_A DeviceInstallParams + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDeviceInstallParamsW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __out PSP_DEVINSTALL_PARAMS_W DeviceInstallParams + ); + +#ifdef UNICODE +#define SetupDiGetDeviceInstallParams SetupDiGetDeviceInstallParamsW +#else +#define SetupDiGetDeviceInstallParams SetupDiGetDeviceInstallParamsA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassInstallParamsA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __out_bcount_opt(ClassInstallParamsSize) PSP_CLASSINSTALL_HEADER ClassInstallParams, + __in DWORD ClassInstallParamsSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassInstallParamsW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __out_bcount_opt(ClassInstallParamsSize) PSP_CLASSINSTALL_HEADER ClassInstallParams, + __in DWORD ClassInstallParamsSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetClassInstallParams SetupDiGetClassInstallParamsW +#else +#define SetupDiGetClassInstallParams SetupDiGetClassInstallParamsA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDeviceInstallParamsA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DEVINSTALL_PARAMS_A DeviceInstallParams + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDeviceInstallParamsW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DEVINSTALL_PARAMS_W DeviceInstallParams + ); + +#ifdef UNICODE +#define SetupDiSetDeviceInstallParams SetupDiSetDeviceInstallParamsW +#else +#define SetupDiSetDeviceInstallParams SetupDiSetDeviceInstallParamsA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetClassInstallParamsA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in_bcount_opt(ClassInstallParamsSize) PSP_CLASSINSTALL_HEADER ClassInstallParams, + __in DWORD ClassInstallParamsSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetClassInstallParamsW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in_bcount_opt(ClassInstallParamsSize) PSP_CLASSINSTALL_HEADER ClassInstallParams, + __in DWORD ClassInstallParamsSize + ); + +#ifdef UNICODE +#define SetupDiSetClassInstallParams SetupDiSetClassInstallParamsW +#else +#define SetupDiSetClassInstallParams SetupDiSetClassInstallParamsA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDriverInstallParamsA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DRVINFO_DATA_A DriverInfoData, + __out PSP_DRVINSTALL_PARAMS DriverInstallParams + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetDriverInstallParamsW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DRVINFO_DATA_W DriverInfoData, + __out PSP_DRVINSTALL_PARAMS DriverInstallParams + ); + +#ifdef UNICODE +#define SetupDiGetDriverInstallParams SetupDiGetDriverInstallParamsW +#else +#define SetupDiGetDriverInstallParams SetupDiGetDriverInstallParamsA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDriverInstallParamsA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DRVINFO_DATA_A DriverInfoData, + __in PSP_DRVINSTALL_PARAMS DriverInstallParams + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetDriverInstallParamsW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_DRVINFO_DATA_W DriverInfoData, + __in PSP_DRVINSTALL_PARAMS DriverInstallParams + ); + +#ifdef UNICODE +#define SetupDiSetDriverInstallParams SetupDiSetDriverInstallParamsW +#else +#define SetupDiSetDriverInstallParams SetupDiSetDriverInstallParamsA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiLoadClassIcon( + __in CONST GUID *ClassGuid, + __out_opt HICON *LargeIcon, + __out_opt PINT MiniIconIndex + ); + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +WINSETUPAPI +BOOL +WINAPI +SetupDiLoadDeviceIcon( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in UINT cxIcon, + __in UINT cyIcon, + __in DWORD Flags, + __out HICON *hIcon + ); + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + + +// +// Flags controlling the drawing of mini-icons +// +#define DMI_MASK 0x00000001 +#define DMI_BKCOLOR 0x00000002 +#define DMI_USERECT 0x00000004 + +WINSETUPAPI +INT +WINAPI +SetupDiDrawMiniIcon( + __in HDC hdc, + __in RECT rc, + __in INT MiniIconIndex, + __in DWORD Flags + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassBitmapIndex( + __in_opt CONST GUID *ClassGuid, + __out PINT MiniIconIndex + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassImageList( + __out PSP_CLASSIMAGELIST_DATA ClassImageListData + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassImageListExA( + __out PSP_CLASSIMAGELIST_DATA ClassImageListData, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassImageListExW( + __out PSP_CLASSIMAGELIST_DATA ClassImageListData, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetClassImageListEx SetupDiGetClassImageListExW +#else +#define SetupDiGetClassImageListEx SetupDiGetClassImageListExA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassImageIndex( + __in PSP_CLASSIMAGELIST_DATA ClassImageListData, + __in CONST GUID *ClassGuid, + __out PINT ImageIndex + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiDestroyClassImageList( + __in PSP_CLASSIMAGELIST_DATA ClassImageListData + ); + + +// +// PropertySheetType values for the SetupDiGetClassDevPropertySheets API +// +#define DIGCDP_FLAG_BASIC 0x00000001 +#define DIGCDP_FLAG_ADVANCED 0x00000002 + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#define DIGCDP_FLAG_REMOTE_BASIC 0x00000003 // not presently implemented +#define DIGCDP_FLAG_REMOTE_ADVANCED 0x00000004 + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassDevPropertySheetsA( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in LPPROPSHEETHEADERA PropertySheetHeader, + __in DWORD PropertySheetHeaderPageListSize, + __out_opt PDWORD RequiredSize, + __in DWORD PropertySheetType + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetClassDevPropertySheetsW( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in LPPROPSHEETHEADERW PropertySheetHeader, + __in DWORD PropertySheetHeaderPageListSize, + __out_opt PDWORD RequiredSize, + __in DWORD PropertySheetType + ); + +#ifdef UNICODE +#define SetupDiGetClassDevPropertySheets SetupDiGetClassDevPropertySheetsW +#else +#define SetupDiGetClassDevPropertySheets SetupDiGetClassDevPropertySheetsA +#endif + + +// +// Define ICON IDs publicly exposed from setupapi. +// +#define IDI_RESOURCEFIRST 159 +#define IDI_RESOURCE 159 +#define IDI_RESOURCELAST 161 +#define IDI_RESOURCEOVERLAYFIRST 161 +#define IDI_RESOURCEOVERLAYLAST 161 +#define IDI_CONFLICT 161 + +#define IDI_CLASSICON_OVERLAYFIRST 500 +#define IDI_CLASSICON_OVERLAYLAST 502 +#define IDI_PROBLEM_OVL 500 +#define IDI_DISABLED_OVL 501 +#define IDI_FORCED_OVL 502 + + +WINSETUPAPI +BOOL +WINAPI +SetupDiAskForOEMDisk( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiSelectOEMDrv( + __in_opt HWND hwndParent, + __in HDEVINFO DeviceInfoSet, + __inout_opt PSP_DEVINFO_DATA DeviceInfoData + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassNameFromGuidA( + __in CONST GUID *ClassGuid, + __out_ecount(ClassNameSize) PSTR ClassName, + __in DWORD ClassNameSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassNameFromGuidW( + __in CONST GUID *ClassGuid, + __out_ecount(ClassNameSize) PWSTR ClassName, + __in DWORD ClassNameSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiClassNameFromGuid SetupDiClassNameFromGuidW +#else +#define SetupDiClassNameFromGuid SetupDiClassNameFromGuidA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassNameFromGuidExA( + __in CONST GUID *ClassGuid, + __out_ecount(ClassNameSize) PSTR ClassName, + __in DWORD ClassNameSize, + __out_opt PDWORD RequiredSize, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassNameFromGuidExW( + __in CONST GUID *ClassGuid, + __out_ecount(ClassNameSize) PWSTR ClassName, + __in DWORD ClassNameSize, + __out_opt PDWORD RequiredSize, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiClassNameFromGuidEx SetupDiClassNameFromGuidExW +#else +#define SetupDiClassNameFromGuidEx SetupDiClassNameFromGuidExA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassGuidsFromNameA( + __in PCSTR ClassName, + __out_ecount(ClassGuidListSize) LPGUID ClassGuidList, + __in DWORD ClassGuidListSize, + __out PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassGuidsFromNameW( + __in PCWSTR ClassName, + __out_ecount(ClassGuidListSize) LPGUID ClassGuidList, + __in DWORD ClassGuidListSize, + __out PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiClassGuidsFromName SetupDiClassGuidsFromNameW +#else +#define SetupDiClassGuidsFromName SetupDiClassGuidsFromNameA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassGuidsFromNameExA( + __in PCSTR ClassName, + __out_ecount(ClassGuidListSize) LPGUID ClassGuidList, + __in DWORD ClassGuidListSize, + __out PDWORD RequiredSize, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiClassGuidsFromNameExW( + __in PCWSTR ClassName, + __out_ecount(ClassGuidListSize) LPGUID ClassGuidList, + __in DWORD ClassGuidListSize, + __out PDWORD RequiredSize, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiClassGuidsFromNameEx SetupDiClassGuidsFromNameExW +#else +#define SetupDiClassGuidsFromNameEx SetupDiClassGuidsFromNameExA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetHwProfileFriendlyNameA( + __in DWORD HwProfile, + __out_ecount(FriendlyNameSize) PSTR FriendlyName, + __in DWORD FriendlyNameSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetHwProfileFriendlyNameW( + __in DWORD HwProfile, + __out_ecount(FriendlyNameSize) PWSTR FriendlyName, + __in DWORD FriendlyNameSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetHwProfileFriendlyName SetupDiGetHwProfileFriendlyNameW +#else +#define SetupDiGetHwProfileFriendlyName SetupDiGetHwProfileFriendlyNameA +#endif + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetHwProfileFriendlyNameExA( + __in DWORD HwProfile, + __out_ecount(FriendlyNameSize) PSTR FriendlyName, + __in DWORD FriendlyNameSize, + __out_opt PDWORD RequiredSize, + __in_opt PCSTR MachineName, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetHwProfileFriendlyNameExW( + __in DWORD HwProfile, + __out_ecount(FriendlyNameSize) PWSTR FriendlyName, + __in DWORD FriendlyNameSize, + __out_opt PDWORD RequiredSize, + __in_opt PCWSTR MachineName, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetHwProfileFriendlyNameEx SetupDiGetHwProfileFriendlyNameExW +#else +#define SetupDiGetHwProfileFriendlyNameEx SetupDiGetHwProfileFriendlyNameExA +#endif + + +// +// PageType values for SetupDiGetWizardPage API +// +#define SPWPT_SELECTDEVICE 0x00000001 + +// +// Flags for SetupDiGetWizardPage API +// +#define SPWP_USE_DEVINFO_DATA 0x00000001 + +WINSETUPAPI +HPROPSHEETPAGE +WINAPI +SetupDiGetWizardPage( + __in HDEVINFO DeviceInfoSet, + __in_opt PSP_DEVINFO_DATA DeviceInfoData, + __in PSP_INSTALLWIZARD_DATA InstallWizardData, + __in DWORD PageType, + __in DWORD Flags + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetSelectedDevice( + __in HDEVINFO DeviceInfoSet, + __out PSP_DEVINFO_DATA DeviceInfoData + ); + + +WINSETUPAPI +BOOL +WINAPI +SetupDiSetSelectedDevice( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData + ); + + +#if _SETUPAPI_VER >= _WIN32_WINNT_WS03 + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetActualModelsSectionA( + __in PINFCONTEXT Context, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __out_ecount_opt(InfSectionWithExtSize) PSTR InfSectionWithExt, + __in DWORD InfSectionWithExtSize, + __out_opt PDWORD RequiredSize, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetActualModelsSectionW( + __in PINFCONTEXT Context, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __out_ecount_opt(InfSectionWithExtSize) PWSTR InfSectionWithExt, + __in DWORD InfSectionWithExtSize, + __out_opt PDWORD RequiredSize, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetActualModelsSection SetupDiGetActualModelsSectionW +#else +#define SetupDiGetActualModelsSection SetupDiGetActualModelsSectionA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WS03 + + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetActualSectionToInstallA( + __in HINF InfHandle, + __in PCSTR InfSectionName, + __out_ecount_opt(InfSectionWithExtSize) PSTR InfSectionWithExt, + __in DWORD InfSectionWithExtSize, + __out_opt PDWORD RequiredSize, + __out_opt PSTR *Extension + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetActualSectionToInstallW( + __in HINF InfHandle, + __in PCWSTR InfSectionName, + __out_ecount_opt(InfSectionWithExtSize) PWSTR InfSectionWithExt, + __in DWORD InfSectionWithExtSize, + __out_opt PDWORD RequiredSize, + __out_opt PWSTR *Extension + ); + +#ifdef UNICODE +#define SetupDiGetActualSectionToInstall SetupDiGetActualSectionToInstallW +#else +#define SetupDiGetActualSectionToInstall SetupDiGetActualSectionToInstallA +#endif + + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetActualSectionToInstallExA( + __in HINF InfHandle, + __in PCSTR InfSectionName, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __out_ecount_opt(InfSectionWithExtSize) PSTR InfSectionWithExt, + __in DWORD InfSectionWithExtSize, + __out_opt PDWORD RequiredSize, + __out_opt PSTR *Extension, + __reserved PVOID Reserved + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetActualSectionToInstallExW( + __in HINF InfHandle, + __in PCWSTR InfSectionName, + __in_opt PSP_ALTPLATFORM_INFO AlternatePlatformInfo, + __out_ecount_opt(InfSectionWithExtSize) PWSTR InfSectionWithExt, + __in DWORD InfSectionWithExtSize, + __out_opt PDWORD RequiredSize, + __out_opt PWSTR *Extension, + __reserved PVOID Reserved + ); + +#ifdef UNICODE +#define SetupDiGetActualSectionToInstallEx SetupDiGetActualSectionToInstallExW +#else +#define SetupDiGetActualSectionToInstallEx SetupDiGetActualSectionToInstallExA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// SetupEnumInfSections is for low-level parsing of an INF +// +WINSETUPAPI +BOOL +WINAPI +SetupEnumInfSectionsA ( + __in HINF InfHandle, + __in UINT Index, + __out_ecount_opt(Size) PSTR Buffer, + __in UINT Size, + __out_opt UINT *SizeNeeded + ); + +WINSETUPAPI +BOOL +WINAPI +SetupEnumInfSectionsW ( + __in HINF InfHandle, + __in UINT Index, + __out_ecount_opt(Size) PWSTR Buffer, + __in UINT Size, + __out_opt UINT *SizeNeeded + ); + +#ifdef UNICODE +#define SetupEnumInfSections SetupEnumInfSectionsW +#else +#define SetupEnumInfSections SetupEnumInfSectionsA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +typedef struct _SP_INF_SIGNER_INFO_V1_A { + DWORD cbSize; + CHAR CatalogFile[MAX_PATH]; + CHAR DigitalSigner[MAX_PATH]; + CHAR DigitalSignerVersion[MAX_PATH]; +} SP_INF_SIGNER_INFO_V1_A, *PSP_INF_SIGNER_INFO_V1_A; + +typedef struct _SP_INF_SIGNER_INFO_V1_W { + DWORD cbSize; + WCHAR CatalogFile[MAX_PATH]; + WCHAR DigitalSigner[MAX_PATH]; + WCHAR DigitalSignerVersion[MAX_PATH]; +} SP_INF_SIGNER_INFO_V1_W, *PSP_INF_SIGNER_INFO_V1_W; + +#ifdef UNICODE +typedef SP_INF_SIGNER_INFO_V1_W SP_INF_SIGNER_INFO_V1; +typedef PSP_INF_SIGNER_INFO_V1_W PSP_INF_SIGNER_INFO_V1; +#else +typedef SP_INF_SIGNER_INFO_V1_A SP_INF_SIGNER_INFO_V1; +typedef PSP_INF_SIGNER_INFO_V1_A PSP_INF_SIGNER_INFO_V1; +#endif + +#if _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +typedef struct _SP_INF_SIGNER_INFO_V2_A { + DWORD cbSize; + CHAR CatalogFile[MAX_PATH]; + CHAR DigitalSigner[MAX_PATH]; + CHAR DigitalSignerVersion[MAX_PATH]; + DWORD SignerScore; +} SP_INF_SIGNER_INFO_V2_A, *PSP_INF_SIGNER_INFO_V2_A; + +typedef struct _SP_INF_SIGNER_INFO_V2_W { + DWORD cbSize; + WCHAR CatalogFile[MAX_PATH]; + WCHAR DigitalSigner[MAX_PATH]; + WCHAR DigitalSignerVersion[MAX_PATH]; + DWORD SignerScore; +} SP_INF_SIGNER_INFO_V2_W, *PSP_INF_SIGNER_INFO_V2_W; + +#ifdef UNICODE +typedef SP_INF_SIGNER_INFO_V2_W SP_INF_SIGNER_INFO_V2; +typedef PSP_INF_SIGNER_INFO_V2_W PSP_INF_SIGNER_INFO_V2; +#else +typedef SP_INF_SIGNER_INFO_V2_A SP_INF_SIGNER_INFO_V2; +typedef PSP_INF_SIGNER_INFO_V2_A PSP_INF_SIGNER_INFO_V2; +#endif + +// +// Driver signer scores (high order bit of the signing byte means unsigned) +// +#define SIGNERSCORE_UNKNOWN 0xFF000000 +#define SIGNERSCORE_W9X_SUSPECT 0xC0000000 +#define SIGNERSCORE_UNSIGNED 0x80000000 +#define SIGNERSCORE_AUTHENTICODE 0x0F000000 +#define SIGNERSCORE_WHQL 0x0D000005 // base WHQL. +#define SIGNERSCORE_UNCLASSIFIED 0x0D000004 // UNCLASSIFIED == INBOX == STANDARD == PREMIUM when the SIGNERSCORE_MASK +#define SIGNERSCORE_INBOX 0x0D000003 // filter is applied. +#define SIGNERSCORE_LOGO_STANDARD 0x0D000002 +#define SIGNERSCORE_LOGO_PREMIUM 0x0D000001 + +#define SIGNERSCORE_MASK 0xFF000000 // Mask out all but the upper BYTE which contains the ranking signer information +#define SIGNERSCORE_SIGNED_MASK 0xF0000000 // Mask out only the upper nibble, which tells us if the package is signed or not. + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_LONGHORN + +#if USE_SP_INF_SIGNER_INFO_V1 || (_SETUPAPI_VER < _WIN32_WINNT_LONGHORN) // use version 1 signer info structure + +typedef SP_INF_SIGNER_INFO_V1_A SP_INF_SIGNER_INFO_A; +typedef PSP_INF_SIGNER_INFO_V1_A PSP_INF_SIGNER_INFO_A; +typedef SP_INF_SIGNER_INFO_V1_W SP_INF_SIGNER_INFO_W; +typedef PSP_INF_SIGNER_INFO_V1_W PSP_INF_SIGNER_INFO_W; +typedef SP_INF_SIGNER_INFO_V1 SP_INF_SIGNER_INFO; +typedef PSP_INF_SIGNER_INFO_V1 PSP_INF_SIGNER_INFO; + +#else // use version 2 signer info structure + +typedef SP_INF_SIGNER_INFO_V2_A SP_INF_SIGNER_INFO_A; +typedef PSP_INF_SIGNER_INFO_V2_A PSP_INF_SIGNER_INFO_A; +typedef SP_INF_SIGNER_INFO_V2_W SP_INF_SIGNER_INFO_W; +typedef PSP_INF_SIGNER_INFO_V2_W PSP_INF_SIGNER_INFO_W; +typedef SP_INF_SIGNER_INFO_V2 SP_INF_SIGNER_INFO; +typedef PSP_INF_SIGNER_INFO_V2 PSP_INF_SIGNER_INFO; + +#endif // use current version of signer info structure + + +WINSETUPAPI +BOOL +WINAPI +SetupVerifyInfFileA( + __in PCSTR InfName, + __in_opt PSP_ALTPLATFORM_INFO AltPlatformInfo, + __inout PSP_INF_SIGNER_INFO_A InfSignerInfo + ); + +WINSETUPAPI +BOOL +WINAPI +SetupVerifyInfFileW( + __in PCWSTR InfName, + __in_opt PSP_ALTPLATFORM_INFO AltPlatformInfo, + __inout PSP_INF_SIGNER_INFO_W InfSignerInfo + ); + +#ifdef UNICODE +#define SetupVerifyInfFile SetupVerifyInfFileW +#else +#define SetupVerifyInfFile SetupVerifyInfFileA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +#if _SETUPAPI_VER >= _WIN32_WINNT_WINXP + +// +// Flags for use by SetupDiGetCustomDeviceProperty +// +#define DICUSTOMDEVPROP_MERGE_MULTISZ 0x00000001 + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetCustomDevicePropertyA( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in PCSTR CustomPropertyName, + __in DWORD Flags, + __out_opt PDWORD PropertyRegDataType, + __out_bcount(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize + ); + +WINSETUPAPI +BOOL +WINAPI +SetupDiGetCustomDevicePropertyW( + __in HDEVINFO DeviceInfoSet, + __in PSP_DEVINFO_DATA DeviceInfoData, + __in PCWSTR CustomPropertyName, + __in DWORD Flags, + __out_opt PDWORD PropertyRegDataType, + __out_bcount(PropertyBufferSize) PBYTE PropertyBuffer, + __in DWORD PropertyBufferSize, + __out_opt PDWORD RequiredSize + ); + +#ifdef UNICODE +#define SetupDiGetCustomDeviceProperty SetupDiGetCustomDevicePropertyW +#else +#define SetupDiGetCustomDeviceProperty SetupDiGetCustomDevicePropertyA +#endif + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WINXP + + +#if _SETUPAPI_VER >= _WIN32_WINNT_WS03 + +// +// To configure WMI security for downlevel platforms where the [DDInstall.WMI] +// section isn't natively supported by setupapi, a redistributable co-installer +// is supplied in the DDK for use on those platforms. +// + +// +// Flags for use by SetupConfigureWmiFromInfSection +// +#define SCWMI_CLOBBER_SECURITY 0x00000001 + +WINSETUPAPI +BOOL +WINAPI +SetupConfigureWmiFromInfSectionA( + __in HINF InfHandle, + __in PCSTR SectionName, + __in DWORD Flags + ); + +WINSETUPAPI +BOOL +WINAPI +SetupConfigureWmiFromInfSectionW( + __in HINF InfHandle, + __in PCWSTR SectionName, + __in DWORD Flags + ); + +#ifdef UNICODE +#define SetupConfigureWmiFromInfSection SetupConfigureWmiFromInfSectionW +#else +#define SetupConfigureWmiFromInfSection SetupConfigureWmiFromInfSectionA +#endif + + +#endif // _SETUPAPI_VER >= _WIN32_WINNT_WS03 + + + +#ifdef __cplusplus +} +#endif + +#include + +#if defined (_MSC_VER) && (_MSC_VER >= 1200) +#pragma warning(pop) +#endif + +#endif // _INC_SETUPAPI + diff --git a/setupapi-x64/hid.lib b/setupapi-x64/hid.lib new file mode 100644 index 0000000..302cf5a Binary files /dev/null and b/setupapi-x64/hid.lib differ diff --git a/setupapi-x64/hidpi.h b/setupapi-x64/hidpi.h new file mode 100644 index 0000000..e5811b6 --- /dev/null +++ b/setupapi-x64/hidpi.h @@ -0,0 +1,1829 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + HIDPI.H + +Abstract: + + Public Interface to the HID parsing library. + +Environment: + + Kernel & user mode + +--*/ + +#ifndef __HIDPI_H__ +#define __HIDPI_H__ + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4115) // named type definition in parentheses +#pragma warning(disable:4201) // nameless struct/union +#pragma warning(disable:4214) // bit field types other than int + +#include + +// Please include "hidsdi.h" to use the user space (dll / parser) +// Please include "hidpddi.h" to use the kernel space parser + +// +// Special Link collection values for using the query functions +// +// Root collection references the collection at the base of the link +// collection tree. +// Unspecifies, references all collections in the link collection tree. +// +#define HIDP_LINK_COLLECTION_ROOT ((USHORT) -1) +#define HIDP_LINK_COLLECTION_UNSPECIFIED ((USHORT) 0) + + +typedef enum _HIDP_REPORT_TYPE +{ + HidP_Input, + HidP_Output, + HidP_Feature +} HIDP_REPORT_TYPE; + +typedef struct _USAGE_AND_PAGE +{ + USAGE Usage; + USAGE UsagePage; +} USAGE_AND_PAGE, *PUSAGE_AND_PAGE; + +#define HidP_IsSameUsageAndPage(u1, u2) ((* (PULONG) &u1) == (* (PULONG) &u2)) + +typedef struct _HIDP_BUTTON_CAPS +{ + USAGE UsagePage; + UCHAR ReportID; + BOOLEAN IsAlias; + + USHORT BitField; + USHORT LinkCollection; // A unique internal index pointer + + USAGE LinkUsage; + USAGE LinkUsagePage; + + BOOLEAN IsRange; + BOOLEAN IsStringRange; + BOOLEAN IsDesignatorRange; + BOOLEAN IsAbsolute; + + ULONG Reserved[10]; + union { + struct { + USAGE UsageMin, UsageMax; + USHORT StringMin, StringMax; + USHORT DesignatorMin, DesignatorMax; + USHORT DataIndexMin, DataIndexMax; + } Range; + struct { + USAGE Usage, Reserved1; + USHORT StringIndex, Reserved2; + USHORT DesignatorIndex, Reserved3; + USHORT DataIndex, Reserved4; + } NotRange; + }; + +} HIDP_BUTTON_CAPS, *PHIDP_BUTTON_CAPS; + + +typedef struct _HIDP_VALUE_CAPS +{ + USAGE UsagePage; + UCHAR ReportID; + BOOLEAN IsAlias; + + USHORT BitField; + USHORT LinkCollection; // A unique internal index pointer + + USAGE LinkUsage; + USAGE LinkUsagePage; + + BOOLEAN IsRange; + BOOLEAN IsStringRange; + BOOLEAN IsDesignatorRange; + BOOLEAN IsAbsolute; + + BOOLEAN HasNull; // Does this channel have a null report union + UCHAR Reserved; + USHORT BitSize; // How many bits are devoted to this value? + + USHORT ReportCount; // See Note below. Usually set to 1. + USHORT Reserved2[5]; + + ULONG UnitsExp; + ULONG Units; + + LONG LogicalMin, LogicalMax; + LONG PhysicalMin, PhysicalMax; + + union { + struct { + USAGE UsageMin, UsageMax; + USHORT StringMin, StringMax; + USHORT DesignatorMin, DesignatorMax; + USHORT DataIndexMin, DataIndexMax; + } Range; + + struct { + USAGE Usage, Reserved1; + USHORT StringIndex, Reserved2; + USHORT DesignatorIndex, Reserved3; + USHORT DataIndex, Reserved4; + } NotRange; + }; +} HIDP_VALUE_CAPS, *PHIDP_VALUE_CAPS; + +// +// Notes: +// +// ReportCount: When a report descriptor declares an Input, Output, or +// Feature main item with fewer usage declarations than the report count, then +// the last usage applies to all remaining unspecified count in that main item. +// (As an example you might have data that required many fields to describe, +// possibly buffered bytes.) In this case, only one value cap structure is +// allocated for these associtated fields, all with the same usage, and Report +// Count reflects the number of fields involved. Normally ReportCount is 1. +// To access all of the fields in such a value structure would require using +// HidP_GetUsageValueArray and HidP_SetUsageValueArray. HidP_GetUsageValue/ +// HidP_SetScaledUsageValue will also work, however, these functions will only +// work with the first field of the structure. +// + +// +// The link collection tree consists of an array of LINK_COLLECTION_NODES +// where the index into this array is the same as the collection number. +// +// Given a collection A which contains a subcollection B, A is defined to be +// the parent B, and B is defined to be the child. +// +// Given collections A, B, and C where B and C are children of A, and B was +// encountered before C in the report descriptor, B is defined as a sibling of +// C. (This implies, of course, that if B is a sibling of C, then C is NOT a +// sibling of B). +// +// B is defined as the NextSibling of C if and only if there exists NO +// child collection of A, call it D, such that B is a sibling of D and D +// is a sibling of C. +// +// E is defined to be the FirstChild of A if and only if for all children of A, +// F, that are not equivalent to E, F is a sibling of E. +// (This implies, of course, that the does not exist a child of A, call it G, +// where E is a sibling of G). In other words the first sibling is the last +// link collection found in the list. +// +// In other words, if a collection B is defined within the definition of another +// collection A, B becomes a child of A. All collections with the same parent +// are considered siblings. The FirstChild of the parent collection, A, will be +// last collection defined that has A as a parent. The order of sibling pointers +// is similarly determined. When a collection B is defined, it becomes the +// FirstChild of it's parent collection. The previously defined FirstChild of the +// parent collection becomes the NextSibling of the new collection. As new +// collections with the same parent are discovered, the chain of sibling is built. +// +// With that in mind, the following describes conclusively a data structure +// that provides direct traversal up, down, and accross the link collection +// tree. +// +// +typedef struct _HIDP_LINK_COLLECTION_NODE +{ + USAGE LinkUsage; + USAGE LinkUsagePage; + USHORT Parent; + USHORT NumberOfChildren; + USHORT NextSibling; + USHORT FirstChild; + ULONG CollectionType: 8; // As defined in 6.2.2.6 of HID spec + ULONG IsAlias : 1; // This link node is an allias of the next link node. + ULONG Reserved: 23; + PVOID UserContext; // The user can hang his coat here. +} HIDP_LINK_COLLECTION_NODE, *PHIDP_LINK_COLLECTION_NODE; + +// +// When a link collection is described by a delimiter, alias link collection +// nodes are created. (One for each usage within the delimiter). +// The parser assigns each capability description listed above only one +// link collection. +// +// If a control is defined within a collection defined by +// delimited usages, then that control is said to be within multiple link +// collections, one for each usage within the open and close delimiter tokens. +// Such multiple link collecions are said to be aliases. The first N-1 such +// collections, listed in the link collection node array, have their IsAlias +// bit set. The last such link collection is the link collection index used +// in the capabilities described above. +// Clients wishing to set a control in an aliased collection, should walk the +// collection array once for each time they see the IsAlias flag set, and use +// the last link collection as the index for the below accessor functions. +// +// NB: if IsAlias is set, then NextSibling should be one more than the current +// link collection node index. +// + +typedef PUCHAR PHIDP_REPORT_DESCRIPTOR; +typedef struct _HIDP_PREPARSED_DATA * PHIDP_PREPARSED_DATA; + +typedef struct _HIDP_CAPS +{ + USAGE Usage; + USAGE UsagePage; + USHORT InputReportByteLength; + USHORT OutputReportByteLength; + USHORT FeatureReportByteLength; + USHORT Reserved[17]; + + USHORT NumberLinkCollectionNodes; + + USHORT NumberInputButtonCaps; + USHORT NumberInputValueCaps; + USHORT NumberInputDataIndices; + + USHORT NumberOutputButtonCaps; + USHORT NumberOutputValueCaps; + USHORT NumberOutputDataIndices; + + USHORT NumberFeatureButtonCaps; + USHORT NumberFeatureValueCaps; + USHORT NumberFeatureDataIndices; +} HIDP_CAPS, *PHIDP_CAPS; + +typedef struct _HIDP_DATA +{ + USHORT DataIndex; + USHORT Reserved; + union { + ULONG RawValue; // for values + BOOLEAN On; // for buttons MUST BE TRUE for buttons. + }; +} HIDP_DATA, *PHIDP_DATA; +// +// The HIDP_DATA structure is used with HidP_GetData and HidP_SetData +// functions. +// +// The parser contiguously assigns every control (button or value) in a hid +// device a unique data index from zero to NumberXXXDataIndices -1 , inclusive. +// This value is found in the HIDP_BUTTON_CAPS and HIDP_VALUE_CAPS structures. +// +// Most clients will find the Get/Set Buttons / Value accessor functions +// sufficient to their needs, as they will allow the clients to access the +// data known to them while ignoring the other controls. +// +// More complex clients, which actually read the Button / Value Caps, and which +// do a value add service to these routines (EG Direct Input), will need to +// access all the data in the device without interest in the individual usage +// or link collection location. These are the clients that will find +// HidP_Data useful. +// + +typedef struct _HIDP_UNKNOWN_TOKEN +{ + UCHAR Token; + UCHAR Reserved[3]; + ULONG BitField; +} HIDP_UNKNOWN_TOKEN, *PHIDP_UNKNOWN_TOKEN; + +typedef struct _HIDP_EXTENDED_ATTRIBUTES +{ + UCHAR NumGlobalUnknowns; + UCHAR Reserved [3]; + PHIDP_UNKNOWN_TOKEN GlobalUnknowns; + // ... Additional attributes + ULONG Data [1]; // variableLength DO NOT ACCESS THIS FIELD +} HIDP_EXTENDED_ATTRIBUTES, *PHIDP_EXTENDED_ATTRIBUTES; + +__checkReturn +__drv_maxIRQL(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_GetCaps ( + __in PHIDP_PREPARSED_DATA PreparsedData, + __out PHIDP_CAPS Capabilities + ); +/*++ +Routine Description: + Returns a list of capabilities of a given hid device as described by its + preparsed data. + +Arguments: + PreparsedData The preparsed data returned from HIDCLASS. + Capabilities a HIDP_CAPS structure + +Return Value: + HIDP_STATUS_SUCCESS + HIDP_STATUS_INVALID_PREPARSED_DATA +--*/ + +__checkReturn +__drv_maxIRQL(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetLinkCollectionNodes ( + OUT PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes, + __inout PULONG LinkCollectionNodesLength, + __in PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Routine Description: + Return a list of PHIDP_LINK_COLLECTION_NODEs used to describe the link + collection tree of this hid device. See the above description of + struct _HIDP_LINK_COLLECTION_NODE. + +Arguments: + LinkCollectionNodes - a caller allocated array into which + HidP_GetLinkCollectionNodes will store the information + + LinKCollectionNodesLength - the caller sets this value to the length of the + the array in terms of number of elements. + HidP_GetLinkCollectionNodes sets this value to the actual + number of elements set. The total number of nodes required to + describe this HID device can be found in the + NumberLinkCollectionNodes field in the HIDP_CAPS structure. + +--*/ + +__checkReturn +__drv_maxIRQL(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_GetSpecificButtonCaps ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, // Optional (0 => ignore) + __in USHORT LinkCollection, // Optional (0 => ignore) + __in USAGE Usage, // Optional (0 => ignore) + OUT PHIDP_BUTTON_CAPS ButtonCaps, + __inout PUSHORT ButtonCapsLength, + __in PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Description: + HidP_GetButtonCaps returns all the buttons (binary values) that are a part + of the given report type for the Hid device represented by the given + preparsed data. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + UsagePage A usage page value used to limit the button caps returned to + those on a given usage page. If set to 0, this parameter is + ignored. Can be used with LinkCollection and Usage parameters + to further limit the number of button caps structures returned. + + LinkCollection HIDP_LINK_COLLECTION node array index used to limit the + button caps returned to those buttons in a given link + collection. If set to 0, this parameter is + ignored. Can be used with UsagePage and Usage parameters + to further limit the number of button caps structures + returned. + + Usage A usage value used to limit the button caps returned to those + with the specified usage value. If set to 0, this parameter + is ignored. Can be used with LinkCollection and UsagePage + parameters to further limit the number of button caps + structures returned. + + ButtonCaps A _HIDP_BUTTON_CAPS array containing information about all the + binary values in the given report. This buffer is provided by + the caller. + + ButtonLength As input, this parameter specifies the length of the + ButtonCaps parameter (array) in number of array elements. + As output, this value is set to indicate how many of those + array elements were filled in by the function. The maximum number of + button caps that can be returned is found in the HIDP_CAPS + structure. If HIDP_STATUS_BUFFER_TOO_SMALL is returned, + this value contains the number of array elements needed to + successfully complete the request. + + PreparsedData The preparsed data returned from HIDCLASS. + + +Return Value +HidP_GetSpecificButtonCaps returns the following error codes: + HIDP_STATUS_SUCCESS. + HIDP_STATUS_INVALID_REPORT_TYPE + HIDP_STATUS_INVALID_PREPARSED_DATA + HIDP_STATUS_BUFFER_TOO_SMALL (all given entries however have been filled in) + HIDP_STATUS_USAGE_NOT_FOUND +--*/ +__checkReturn +__drv_maxIRQL(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_GetButtonCaps ( + __in HIDP_REPORT_TYPE ReportType, + __out_ecount_part(*ButtonCapsLength, *ButtonCapsLength) PHIDP_BUTTON_CAPS ButtonCaps, + __inout PUSHORT ButtonCapsLength, + __in PHIDP_PREPARSED_DATA PreparsedData +); + +__checkReturn +__drv_maxIRQL(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetSpecificValueCaps ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, // Optional (0 => ignore) + __in USHORT LinkCollection, // Optional (0 => ignore) + __in USAGE Usage, // Optional (0 => ignore) + OUT PHIDP_VALUE_CAPS ValueCaps, + __inout PUSHORT ValueCapsLength, + __in PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Description: + HidP_GetValueCaps returns all the values (non-binary) that are a part + of the given report type for the Hid device represented by the given + preparsed data. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + UsagePage A usage page value used to limit the value caps returned to + those on a given usage page. If set to 0, this parameter is + ignored. Can be used with LinkCollection and Usage parameters + to further limit the number of value caps structures returned. + + LinkCollection HIDP_LINK_COLLECTION node array index used to limit the + value caps returned to those buttons in a given link + collection. If set to 0, this parameter is + ignored. Can be used with UsagePage and Usage parameters + to further limit the number of value caps structures + returned. + + Usage A usage value used to limit the value caps returned to those + with the specified usage value. If set to 0, this parameter + is ignored. Can be used with LinkCollection and UsagePage + parameters to further limit the number of value caps + structures returned. + + ValueCaps A _HIDP_VALUE_CAPS array containing information about all the + non-binary values in the given report. This buffer is provided + by the caller. + + ValueLength As input, this parameter specifies the length of the ValueCaps + parameter (array) in number of array elements. As output, + this value is set to indicate how many of those array elements + were filled in by the function. The maximum number of + value caps that can be returned is found in the HIDP_CAPS + structure. If HIDP_STATUS_BUFFER_TOO_SMALL is returned, + this value contains the number of array elements needed to + successfully complete the request. + + PreparsedData The preparsed data returned from HIDCLASS. + + +Return Value +HidP_GetValueCaps returns the following error codes: + HIDP_STATUS_SUCCESS. + HIDP_STATUS_INVALID_REPORT_TYPE + HIDP_STATUS_INVALID_PREPARSED_DATA + HIDP_STATUS_BUFFER_TOO_SMALL (all given entries however have been filled in) + HIDP_STATUS_USAGE_NOT_FOUND + +--*/ + +__checkReturn +__drv_maxIRQL(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetValueCaps ( + __in HIDP_REPORT_TYPE ReportType, + __out_ecount_part(*ValueCapsLength, *ValueCapsLength) PHIDP_VALUE_CAPS ValueCaps, + __inout PUSHORT ValueCapsLength, + __in PHIDP_PREPARSED_DATA PreparsedData +); + +__checkReturn +__drv_maxIRQL(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetExtendedAttributes ( + __in HIDP_REPORT_TYPE ReportType, + __in USHORT DataIndex, + __in PHIDP_PREPARSED_DATA PreparsedData, + __out_ecount_part(*LengthAttributes, *LengthAttributes) PHIDP_EXTENDED_ATTRIBUTES Attributes, + __inout PULONG LengthAttributes + ); +/*++ +Description: + Given a data index from the value or button capabilities of a given control + return any extended attributes for the control if any exist. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + DataIndex The data index for the given control, found in the capabilities + structure for that control + + PreparsedData The preparsed data returned from HIDCLASS. + + Attributes Pointer to a buffer into which the extended attribute data will + be copied. + + LengthAttributes Length of the given buffer in bytes. + +Return Value + HIDP_STATUS_SUCCESS + HIDP_STATUS_DATA_INDEX_NOT_FOUND +--*/ + +__checkReturn +__drv_maxIRQL(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_InitializeReportForID ( + __in HIDP_REPORT_TYPE ReportType, + __in UCHAR ReportID, + __in PHIDP_PREPARSED_DATA PreparsedData, + __out_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); +/*++ + +Routine Description: + + Initialize a report based on the given report ID. + +Parameters: + + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + PreparasedData Preparsed data structure returned by HIDCLASS + + Report Buffer which to set the data into. + + ReportLength Length of Report...Report should be at least as long as the + value indicated in the HIDP_CAPS structure for the device and + the corresponding ReportType + +Return Value + + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not equal + to the length specified in HIDP_CAPS + structure for the given ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + +--*/ + +__checkReturn +NTSTATUS __stdcall +HidP_SetData ( + __in HIDP_REPORT_TYPE ReportType, + __inout_ecount_part(*DataLength,*DataLength) PHIDP_DATA DataList, + __inout PULONG DataLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __in_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); +/*++ + +Routine Description: + + Please Note: Since usage value arrays deal with multiple fields for + for one usage value, they cannot be used with HidP_SetData + and HidP_GetData. In this case, + HIDP_STATUS_IS_USAGE_VALUE_ARRAY will be returned. + +Parameters: + + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + DataList Array of HIDP_DATA structures that contains the data values + that are to be set into the given report + + DataLength As input, length in array elements of DataList. As output, + contains the number of data elements set on successful + completion or an index into the DataList array to identify + the faulting HIDP_DATA value if an error code is returned. + + PreparasedData Preparsed data structure returned by HIDCLASS + + Report Buffer which to set the data into. + + ReportLength Length of Report...Report should be at least as long as the + value indicated in the HIDP_CAPS structure for the device and + the corresponding ReportType + +Return Value + HidP_SetData returns the following error codes. The report packet will + have all the data set up until the HIDP_DATA structure that caused the + error. DataLength, in the error case, will return this problem index. + + HIDP_STATUS_SUCCESS -- upon successful insertion of all data + into the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_DATA_INDEX_NOT_FOUND -- if a HIDP_DATA structure referenced a + data index that does not exist for this + device's ReportType + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not equal + to the length specified in HIDP_CAPS + structure for the given ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_IS_USAGE_VALUE_ARRAY -- if one of the HIDP_DATA structures + references a usage value array. + DataLength will contain the index into + the array that was invalid + HIDP_STATUS_BUTTON_NOT_PRESSED -- if a HIDP_DATA structure attempted + to unset a button that was not already + set in the Report + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- a HIDP_DATA structure was found with + a valid index value but is contained + in a different report than the one + currently being processed + HIDP_STATUS_BUFFER_TOO_SMALL -- if there are not enough entries in + a given Main Array Item to report all + buttons that have been requested to be + set +--*/ + +__checkReturn +__drv_maxIRQL(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetData ( + __in HIDP_REPORT_TYPE ReportType, + __out_ecount_part(*DataLength,*DataLength) PHIDP_DATA DataList, + __inout PULONG DataLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __out_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); +/*++ + +Routine Description: + + Please Note: For obvious reasons HidP_SetData and HidP_GetData will not + access UsageValueArrays. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + DataList Array of HIDP_DATA structures that will receive the data + values that are set in the given report + + DataLength As input, length in array elements of DataList. As output, + contains the number of data elements that were successfully + set by HidP_GetData. The maximum size necessary for DataList + can be determined by calling HidP_MaxDataListLength + + PreparasedData Preparsed data structure returned by HIDCLASS + + Report Buffer which to set the data into. + + ReportLength Length of Report...Report should be at least as long as the + value indicated in the HIDP_CAPS structure for the device and + the corresponding ReportType + +Return Value + HidP_GetData returns the following error codes. + + HIDP_STATUS_SUCCESS -- upon successful retrieval of all data + from the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not equal + to the length specified in HIDP_CAPS + structure for the given ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_BUFFER_TOO_SMALL -- if there are not enough array entries in + DataList to store all the indice values + in the given report. DataLength will + contain the number of array entries + required to hold all data +--*/ + +__drv_maxIRQL(DISPATCH_LEVEL) +ULONG __stdcall +HidP_MaxDataListLength ( + __in HIDP_REPORT_TYPE ReportType, + __in PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Routine Description: + + This function returns the maximum length of HIDP_DATA elements that + HidP_GetData could return for the given report type. + +Parameters: + + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + PreparsedData Preparsed data structure returned by HIDCLASS + +Return Value: + + The length of the data list array required for the HidP_GetData function + call. If an error occurs (either HIDP_STATUS_INVALID_REPORT_TYPE or + HIDP_STATUS_INVALID_PREPARSED_DATA), this function returns 0. + +--*/ + +#define HidP_SetButtons(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) \ + HidP_SetUsages(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) + +__checkReturn +NTSTATUS __stdcall +HidP_SetUsages ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __inout_ecount_part(*UsageLength,*UsageLength) PUSAGE UsageList, + __inout PULONG UsageLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __in_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); +/*++ + +Routine Description: + This function sets binary values (buttons) in a report. Given an + initialized packet of correct length, it modifies the report packet so that + each element in the given list of usages has been set in the report packet. + For example, in an output report with 5 LED's, each with a given usage, + an application could turn on any subset of these lights by placing their + usages in any order into the usage array (UsageList). HidP_SetUsages would, + in turn, set the appropriate bit or add the corresponding byte into the + HID Main Array Item. + + A properly initialized Report packet is one of the correct byte length, + and all zeros. + + NOTE: A packet that has already been set with a call to a HidP_Set routine + can also be passed in. This routine then sets processes the UsageList + in the same fashion but verifies that the ReportID already set in + Report matches the report ID for the given usages. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage All of the usages in the usage array, which HidP_SetUsages will + set in the report, refer to this same usage page. + If a client wishes to set usages in a report for multiple + usage pages then that client needs to make multiple calls to + HidP_SetUsages for each of the usage pages. + + UsageList A usage array containing the usages that HidP_SetUsages will set in + the report packet. + + UsageLength The length of the given usage array in array elements. + The parser will set this value to the position in the usage + array where it stopped processing. If successful, UsageLength + will be unchanged. In any error condition, this parameter + reflects how many of the usages in the usage list have + actually been set by the parser. This is useful for finding + the usage in the list which caused the error. + + PreparsedData The preparsed data recevied from HIDCLASS + + Report The report packet. + + ReportLength Length of the given report packet...Must be equal to the + value reported in the HIDP_CAPS structure for the device + and corresponding report type. + +Return Value + HidP_SetUsages returns the following error codes. On error, the report packet + will be correct up until the usage element that caused the error. + + HIDP_STATUS_SUCCESS -- upon successful insertion of all usages + into the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if a usage was found that exists in a + different report. If the report is + zero-initialized on entry the first + usage in the list will determine which + report ID is used. Otherwise, the + parser will verify that usage matches + the passed in report's ID + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage does not exist for any + report (no matter what the report ID) + for the given report type. + HIDP_STATUS_BUFFER_TOO_SMALL -- if there are not enough entries in a + given Main Array Item to list all of + the given usages. The caller needs + to split his request into more than + one call +--*/ + +#define HidP_UnsetButtons(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) \ + HidP_UnsetUsages(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) + +__checkReturn +NTSTATUS __stdcall +HidP_UnsetUsages ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in_opt USHORT LinkCollection, + __inout_ecount_part(*UsageLength,*UsageLength) PUSAGE UsageList, + __inout PULONG UsageLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __in_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); +/*++ + +Routine Description: + This function unsets (turns off) binary values (buttons) in the report. Given + an initialized packet of correct length, it modifies the report packet so + that each element in the given list of usages has been unset in the + report packet. + + This function is the "undo" operation for SetUsages. If the given usage + is not already set in the Report, it will return an error code of + HIDP_STATUS_BUTTON_NOT_PRESSED. If the button is pressed, HidP_UnsetUsages + will unset the appropriate bit or remove the corresponding index value from + the HID Main Array Item. + + A properly initialized Report packet is one of the correct byte length, + and all zeros.. + + NOTE: A packet that has already been set with a call to a HidP_Set routine + can also be passed in. This routine then processes the UsageList + in the same fashion but verifies that the ReportID already set in + Report matches the report ID for the given usages. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage All of the usages in the usage array, which HidP_UnsetUsages will + unset in the report, refer to this same usage page. + If a client wishes to unset usages in a report for multiple + usage pages then that client needs to make multiple calls to + HidP_UnsetUsages for each of the usage pages. + + UsageList A usage array containing the usages that HidP_UnsetUsages will + unset in the report packet. + + UsageLength The length of the given usage array in array elements. + The parser will set this value to the position in the usage + array where it stopped processing. If successful, UsageLength + will be unchanged. In any error condition, this parameter + reflects how many of the usages in the usage list have + actually been unset by the parser. This is useful for finding + the usage in the list which caused the error. + + PreparsedData The preparsed data recevied from HIDCLASS + + Report The report packet. + + ReportLength Length of the given report packet...Must be equal to the + value reported in the HIDP_CAPS structure for the device + and corresponding report type. + +Return Value + HidP_UnsetUsages returns the following error codes. On error, the report + packet will be correct up until the usage element that caused the error. + + HIDP_STATUS_SUCCESS -- upon successful "unsetting" of all usages + in the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if a usage was found that exists in a + different report. If the report is + zero-initialized on entry the first + usage in the list will determine which + report ID is used. Otherwise, the + parser will verify that usage matches + the passed in report's ID + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage does not exist for any + report (no matter what the report ID) + for the given report type. + HIDP_STATUS_BUTTON_NOT_PRESSED -- if a usage corresponds to a button that + is not already set in the given report +--*/ + +#define HidP_GetButtons(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe) \ + HidP_GetUsages(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe) + +__checkReturn +NTSTATUS __stdcall +HidP_GetUsages ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __out_ecount(UsageLength) PUSAGE UsageList, + __inout PULONG UsageLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __out_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); +/*++ + +Routine Description: + This function returns the binary values (buttons) that are set in a HID + report. Given a report packet of correct length, it searches the report + packet for each usage for the given usage page and returns them in the + usage list. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage All of the usages in the usage list, which HidP_GetUsages will + retrieve in the report, refer to this same usage page. + If the client wishes to get usages in a packet for multiple + usage pages then that client needs to make multiple calls + to HidP_GetUsages. + + LinkCollection An optional value which can limit which usages are returned + in the UsageList to those usages that exist in a specific + LinkCollection. A non-zero value indicates the index into + the HIDP_LINK_COLLECITON_NODE list returned by + HidP_GetLinkCollectionNodes of the link collection the + usage should belong to. A value of 0 indicates this + should value be ignored. + + UsageList The usage array that will contain all the usages found in + the report packet. + + UsageLength The length of the given usage array in array elements. + On input, this value describes the length of the usage list. + On output, HidP_GetUsages sets this value to the number of + usages that was found. Use HidP_MaxUsageListLength to + determine the maximum length needed to return all the usages + that a given report packet may contain. + + PreparsedData Preparsed data structure returned by HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet + + +Return Value + HidP_GetUsages returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving all the + usages from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_BUFFER_TOO_SMALL -- if the UsageList is not big enough to + hold all the usages found in the report + packet. If this is returned, the buffer + will contain UsageLength number of + usages. Use HidP_MaxUsageListLength to + find the maximum length needed + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if no usages were found but usages + that match the UsagePage and + LinkCollection specified could be found + in a report with a different report ID + HIDP_STATUS_USAGE_NOT_FOUND -- if there are no usages in a reports for + the device and ReportType that match the + UsagePage and LinkCollection that were + specified +--*/ + +#define HidP_GetButtonsEx(Rty, LCo, BLi, ULe, Ppd, Rep, RLe) \ + HidP_GetUsagesEx(Rty, LCo, BLi, ULe, Ppd, Rep, RLe) + +__checkReturn +__drv_maxIRQL(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetUsagesEx ( + __in HIDP_REPORT_TYPE ReportType, + __in USHORT LinkCollection, // Optional + __inout_ecount_part(*UsageLength,*UsageLength) PUSAGE_AND_PAGE ButtonList, + __inout ULONG * UsageLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __in_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); + +/*++ + +Routine Description: + This function returns the binary values (buttons) in a HID report. + Given a report packet of correct length, it searches the report packet + for all buttons and returns the UsagePage and Usage for each of the buttons + it finds. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + LinkCollection An optional value which can limit which usages are returned + in the ButtonList to those usages that exist in a specific + LinkCollection. A non-zero value indicates the index into + the HIDP_LINK_COLLECITON_NODE list returned by + HidP_GetLinkCollectionNodes of the link collection the + usage should belong to. A value of 0 indicates this + should value be ignored. + + ButtonList An array of USAGE_AND_PAGE structures describing all the + buttons currently ``down'' in the device. + + UsageLength The length of the given array in terms of elements. + On input, this value describes the length of the list. On + output, HidP_GetUsagesEx sets this value to the number of + usages that were found. Use HidP_MaxUsageListLength to + determine the maximum length needed to return all the usages + that a given report packet may contain. + + PreparsedData Preparsed data returned by HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value + HidP_GetUsagesEx returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving all the + usages from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_BUFFER_TOO_SMALL -- if ButtonList is not big enough to + hold all the usages found in the report + packet. If this is returned, the buffer + will contain UsageLength number of + usages. Use HidP_MaxUsageListLength to + find the maximum length needed + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if no usages were found but usages + that match the specified LinkCollection + exist in report with a different report + ID. + HIDP_STATUS_USAGE_NOT_FOUND -- if there are no usages in any reports that + match the LinkCollection parameter +--*/ + +__drv_maxIRQL(PASSIVE_LEVEL) +ULONG __stdcall +HidP_MaxUsageListLength ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, // Optional + __in PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Routine Description: + This function returns the maximum number of usages that a call to + HidP_GetUsages or HidP_GetUsagesEx could return for a given HID report. + If calling for number of usages returned by HidP_GetUsagesEx, use 0 as + the UsagePage value. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage Specifies the optional UsagePage to query for. If 0, will + return all the maximum number of usage values that could be + returned for a given ReportType. If non-zero, will return + the maximum number of usages that would be returned for the + ReportType with the given UsagePage. + + PreparsedData Preparsed data returned from HIDCLASS + +Return Value: + The length of the usage list array required for the HidP_GetUsages or + HidP_GetUsagesEx function call. If an error occurs (such as + HIDP_STATUS_INVALID_REPORT_TYPE or HIDP_INVALID_PREPARSED_DATA, this + returns 0. +--*/ + +__checkReturn +NTSTATUS __stdcall +HidP_SetUsageValue ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __in USAGE Usage, + __in ULONG UsageValue, + __in PHIDP_PREPARSED_DATA PreparsedData, + __inout_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); +/*++ +Description: + HidP_SetUsageValue inserts a value into the HID Report Packet in the field + corresponding to the given usage page and usage. HidP_SetUsageValue + casts this value to the appropriate bit length. If a report packet + contains two different fields with the same Usage and UsagePage, + they can be distinguished with the optional LinkCollection field value. + Using this function sets the raw value into the report packet with + no checking done as to whether it actually falls within the logical + minimum/logical maximum range. Use HidP_SetScaledUsageValue for this... + + NOTE: Although the UsageValue parameter is a ULONG, any casting that is + done will preserve or sign-extend the value. The value being set + should be considered a LONG value and will be treated as such by + this function. + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_SetUsageValue will set. + + UsageValue The raw value to set in the report buffer. This value must be within + the logical range or if a NULL value this value should be the + most negative value that can be represented by the number of bits + for this field. + + PreparsedData The preparsed data returned for HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_SetUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully setting the value + in the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call HidP_SetUsageValue + again with a zero-initizialed report + packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ +__checkReturn +NTSTATUS __stdcall +HidP_SetScaledUsageValue ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __in USAGE Usage, + __in LONG UsageValue, + __in PHIDP_PREPARSED_DATA PreparsedData, + __inout_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); + +/*++ +Description: + HidP_SetScaledUsageValue inserts the UsageValue into the HID report packet + in the field corresponding to the given usage page and usage. If a report + packet contains two different fields with the same Usage and UsagePage, + they can be distinguished with the optional LinkCollection field value. + + If the specified field has a defined physical range, this function converts + the physical value specified to the corresponding logical value for the + report. If a physical value does not exist, the function will verify that + the value specified falls within the logical range and set according. + + If the range checking fails but the field has NULL values, the function will + set the field to the defined NULL value (most negative number possible) and + return HIDP_STATUS_NULL. In other words, use this function to set NULL + values for a given field by passing in a value that falls outside the + physical range if it is defined or the logical range otherwise. + + If the field does not support NULL values, an out of range error will be + returned instead. + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_SetScaledUsageValue will set. + + UsageValue The value to set in the report buffer. See the routine + description above for the different interpretations of this + value + + PreparsedData The preparsed data returned from HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_SetScaledUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully setting the value + in the report packet + HIDP_STATUS_NULL -- upon successfully setting the value + in the report packet as a NULL value + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_VALUE_OUT_OF_RANGE -- if the value specified failed to fall + within the physical range if it exists + or within the logical range otherwise + and the field specified by the usage + does not allow NULL values + HIDP_STATUS_BAD_LOG_PHY_VALUES -- if the field has a physical range but + either the logical range is invalid + (max <= min) or the physical range is + invalid + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_SetScaledUsageValue again with + a zero-initialized report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ +__checkReturn +NTSTATUS __stdcall +HidP_SetUsageValueArray ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __in USAGE Usage, + __in_bcount(UsageValueByteLength) PCHAR UsageValue, + __in USHORT UsageValueByteLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __inout_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); + +/*++ +Routine Descripton: + A usage value array occurs when the last usage in the list of usages + describing a main item must be repeated because there are less usages defined + than there are report counts declared for the given main item. In this case + a single value cap is allocated for that usage and the report count of that + value cap is set to reflect the number of fields to which that usage refers. + + HidP_SetUsageValueArray sets the raw bits for that usage which spans + more than one field in a report. + + NOTE: This function currently does not support value arrays where the + ReportSize for each of the fields in the array is not a multiple + of 8 bits. + + The UsageValue buffer should have the values set as they would appear + in the report buffer. If this function supported non 8-bit multiples + for the ReportSize then caller should format the input buffer so that + each new value begins at the bit immediately following the last bit + of the previous value + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value array HidP_SetUsageValueArray will set. + + UsageValue The buffer with the values to set into the value array. + The number of BITS required is found by multiplying the + BitSize and ReportCount fields of the Value Cap for this + control. The least significant bit of this control found in the + given report will be placed in the least significan bit location + of the array given (little-endian format), regardless of whether + or not the field is byte alligned or if the BitSize is a multiple + of sizeof (CHAR). + + See the above note for current implementation limitations. + + UsageValueByteLength Length of the UsageValue buffer (in bytes) + + PreparsedData The preparsed data returned from HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HIDP_STATUS_SUCCESS -- upon successfully setting the value + array in the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_NOT_VALUE_ARRAY -- if the control specified is not a + value array -- a value array will have + a ReportCount field in the + HIDP_VALUE_CAPS structure that is > 1 + Use HidP_SetUsageValue instead + HIDP_STATUS_BUFFER_TOO_SMALL -- if the size of the passed in buffer with + the values to set is too small (ie. has + fewer values than the number of fields in + the array + HIDP_STATUS_NOT_IMPLEMENTED -- if the usage value array has field sizes + that are not multiples of 8 bits, this + error code is returned since the function + currently does not handle setting into + such arrays. + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_SetUsageValueArray again with + a zero-initialized report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ + +__checkReturn +NTSTATUS __stdcall +HidP_GetUsageValue ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __in USAGE Usage, + __out PULONG UsageValue, + __in PHIDP_PREPARSED_DATA PreparsedData, + __in_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); + +/* +Description + HidP_GetUsageValue retrieves the value from the HID Report for the usage + specified by the combination of usage page, usage and link collection. + If a report packet contains two different fields with the same + Usage and UsagePage, they can be distinguished with the optional + LinkCollection field value. + +Parameters: + + ReportType One of HidP_Input or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_GetUsageValue will retrieve + + UsageValue The raw value that is set for the specified field in the report + buffer. This value will either fall within the logical range + or if NULL values are allowed, a number outside the range to + indicate a NULL + + PreparsedData The preparsed data returned for HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_GetUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving the value + from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call HidP_GetUsageValue + again with a different report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ + +__checkReturn +NTSTATUS __stdcall +HidP_GetScaledUsageValue ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __in USAGE Usage, + __out PLONG UsageValue, + __in PHIDP_PREPARSED_DATA PreparsedData, + __in_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); + +/*++ +Description + HidP_GetScaledUsageValue retrieves a UsageValue from the HID report packet + in the field corresponding to the given usage page and usage. If a report + packet contains two different fields with the same Usage and UsagePage, + they can be distinguished with the optional LinkCollection field value. + + If the specified field has a defined physical range, this function converts + the logical value that exists in the report packet to the corresponding + physical value. If a physical range does not exist, the function will + return the logical value. This function will check to verify that the + logical value in the report falls within the declared logical range. + + When doing the conversion between logical and physical values, this + function assumes a linear extrapolation between the physical max/min and + the logical max/min. (Where logical is the values reported by the device + and physical is the value returned by this function). If the data field + size is less than 32 bits, then HidP_GetScaledUsageValue will sign extend + the value to 32 bits. + + If the range checking fails but the field has NULL values, the function + will set UsageValue to 0 and return HIDP_STATUS_NULL. Otherwise, it + returns a HIDP_STATUS_OUT_OF_RANGE error. + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will retrieve the first + field it finds that matches the usage page + and usage. + + Usage The usage whose value HidP_GetScaledUsageValue will retrieve + + UsageValue The value retrieved from the report buffer. See the routine + description above for the different interpretations of this + value + + PreparsedData The preparsed data returned from HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_GetScaledUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving the value + from the report packet + HIDP_STATUS_NULL -- if the report packet had a NULL value + set + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_VALUE_OUT_OF_RANGE -- if the value retrieved from the packet + falls outside the logical range and + the field does not support NULL values + HIDP_STATUS_BAD_LOG_PHY_VALUES -- if the field has a physical range but + either the logical range is invalid + (max <= min) or the physical range is + invalid + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_GetScaledUsageValue with a + different report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ +__checkReturn +NTSTATUS __stdcall +HidP_GetUsageValueArray ( + __in HIDP_REPORT_TYPE ReportType, + __in USAGE UsagePage, + __in USHORT LinkCollection, + __in USAGE Usage, + __inout_bcount(UsageValueByteLength) PCHAR UsageValue, + __in USHORT UsageValueByteLength, + __in PHIDP_PREPARSED_DATA PreparsedData, + __in_bcount(ReportLength) PCHAR Report, + __in ULONG ReportLength + ); + +/*++ +Routine Descripton: + A usage value array occurs when the last usage in the list of usages + describing a main item must be repeated because there are less usages defined + than there are report counts declared for the given main item. In this case + a single value cap is allocated for that usage and the report count of that + value cap is set to reflect the number of fields to which that usage refers. + + HidP_GetUsageValueArray returns the raw bits for that usage which spans + more than one field in a report. + + NOTE: This function currently does not support value arrays where the + ReportSize for each of the fields in the array is not a multiple + of 8 bits. + + The UsageValue buffer will have the raw values as they are set + in the report packet. + +Parameters: + + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_GetUsageValueArray will retreive. + + UsageValue A pointer to an array of characters where the value will be + placed. The number of BITS required is found by multiplying the + BitSize and ReportCount fields of the Value Cap for this + control. The least significant bit of this control found in the + given report will be placed in the least significant bit location + of the buffer (little-endian format), regardless of whether + or not the field is byte aligned or if the BitSize is a multiple + of sizeof (CHAR). + + See note above about current implementation limitations + + UsageValueByteLength + the length of the given UsageValue buffer. + + PreparsedData The preparsed data returned by the HIDCLASS + + Report The report packet. + + ReportLength Length of the given report packet. + +Return Value: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving the value + from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_NOT_VALUE_ARRAY -- if the control specified is not a + value array -- a value array will have + a ReportCount field in the + HIDP_VALUE_CAPS structure that is > 1 + Use HidP_GetUsageValue instead + HIDP_STATUS_BUFFER_TOO_SMALL -- if the size of the passed in buffer in + which to return the array is too small + (ie. has fewer values than the number of + fields in the array + HIDP_STATUS_NOT_IMPLEMENTED -- if the usage value array has field sizes + that are not multiples of 8 bits, this + error code is returned since the function + currently does not handle getting values + from such arrays. + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_GetUsageValueArray with a + different report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ + +__checkReturn +__drv_maxIRQL(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_UsageListDifference ( + __in_ecount(UsageListLength) PUSAGE PreviousUsageList, + __in_ecount(UsageListLength) PUSAGE CurrentUsageList, + __out_ecount(UsageListLength) PUSAGE BreakUsageList, + __out_ecount(UsageListLength) PUSAGE MakeUsageList, + __in ULONG UsageListLength + ); +/*++ +Routine Description: + This function will return the difference between a two lists of usages + (as might be returned from HidP_GetUsages), In other words, it will return + return a list of usages that are in the current list but not the previous + list as well as a list of usages that are in the previous list but not + the current list. + +Parameters: + + PreviousUsageList The list of usages before. + CurrentUsageList The list of usages now. + BreakUsageList Previous - Current. + MakeUsageList Current - Previous. + UsageListLength Represents the length of the usage lists in array + elements. If comparing two lists with a differing + number of array elements, this value should be + the size of the larger of the two lists. Any + zero found with a list indicates an early termination + of the list and any usages found after the first zero + will be ignored. +--*/ + +__checkReturn +__drv_maxIRQL(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_UsageAndPageListDifference ( + __in_ecount(UsageListLength) PUSAGE_AND_PAGE PreviousUsageList, + __in_ecount(UsageListLength) PUSAGE_AND_PAGE CurrentUsageList, + __out_ecount(UsageListLength) PUSAGE_AND_PAGE BreakUsageList, + __out_ecount(UsageListLength) PUSAGE_AND_PAGE MakeUsageList, + __in ULONG UsageListLength + ); + +// +// Produce Make or Break Codes +// +typedef enum _HIDP_KEYBOARD_DIRECTION { + HidP_Keyboard_Break, + HidP_Keyboard_Make +} HIDP_KEYBOARD_DIRECTION; + +// +// A bitmap of the current shift state of the keyboard when using the +// below keyboard usages to i8042 translation function. +// +typedef struct _HIDP_KEYBOARD_MODIFIER_STATE { + union { + struct { + ULONG LeftControl: 1; + ULONG LeftShift: 1; + ULONG LeftAlt: 1; + ULONG LeftGUI: 1; + ULONG RightControl: 1; + ULONG RightShift: 1; + ULONG RightAlt: 1; + ULONG RigthGUI: 1; + ULONG CapsLock: 1; + ULONG ScollLock: 1; + ULONG NumLock: 1; + ULONG Reserved: 21; + }; + ULONG ul; + }; + +} HIDP_KEYBOARD_MODIFIER_STATE, * PHIDP_KEYBOARD_MODIFIER_STATE; + +// +// A call back function to give the i8042 scan codes to the caller of +// the below translation function. +// +typedef BOOLEAN (* PHIDP_INSERT_SCANCODES) ( + __in_opt PVOID Context, // Some caller supplied context. + __in_bcount(Length) PCHAR NewScanCodes, // A list of i8042 scan codes. + __in ULONG Length // the length of the scan codes. + ); + +__checkReturn +NTSTATUS __stdcall +HidP_TranslateUsageAndPagesToI8042ScanCodes ( + __in_ecount(UsageListLength) PUSAGE_AND_PAGE ChangedUsageList, + __in ULONG UsageListLength, + __in HIDP_KEYBOARD_DIRECTION KeyAction, + __inout PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, + __in PHIDP_INSERT_SCANCODES InsertCodesProcedure, + __in_opt PVOID InsertCodesContext + ); +/*++ +Routine Description: +Parameters: +--*/ +__checkReturn +NTSTATUS __stdcall +HidP_TranslateUsagesToI8042ScanCodes ( + __in_ecount(UsageListLength) PUSAGE ChangedUsageList, + __in ULONG UsageListLength, + __in HIDP_KEYBOARD_DIRECTION KeyAction, + __inout PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, + __in PHIDP_INSERT_SCANCODES InsertCodesProcedure, + __in_opt PVOID InsertCodesContext + ); +/*++ +Routine Description: +Parameters: +--*/ + + + +// +// Define NT Status codes with Facility Code of FACILITY_HID_ERROR_CODE +// + +// FACILITY_HID_ERROR_CODE defined in ntstatus.h +#ifndef FACILITY_HID_ERROR_CODE +#define FACILITY_HID_ERROR_CODE 0x11 +#endif + +#define HIDP_ERROR_CODES(SEV, CODE) \ + ((NTSTATUS) (((SEV) << 28) | (FACILITY_HID_ERROR_CODE << 16) | (CODE))) + +#define HIDP_STATUS_SUCCESS (HIDP_ERROR_CODES(0x0,0)) +#define HIDP_STATUS_NULL (HIDP_ERROR_CODES(0x8,1)) +#define HIDP_STATUS_INVALID_PREPARSED_DATA (HIDP_ERROR_CODES(0xC,1)) +#define HIDP_STATUS_INVALID_REPORT_TYPE (HIDP_ERROR_CODES(0xC,2)) +#define HIDP_STATUS_INVALID_REPORT_LENGTH (HIDP_ERROR_CODES(0xC,3)) +#define HIDP_STATUS_USAGE_NOT_FOUND (HIDP_ERROR_CODES(0xC,4)) +#define HIDP_STATUS_VALUE_OUT_OF_RANGE (HIDP_ERROR_CODES(0xC,5)) +#define HIDP_STATUS_BAD_LOG_PHY_VALUES (HIDP_ERROR_CODES(0xC,6)) +#define HIDP_STATUS_BUFFER_TOO_SMALL (HIDP_ERROR_CODES(0xC,7)) +#define HIDP_STATUS_INTERNAL_ERROR (HIDP_ERROR_CODES(0xC,8)) +#define HIDP_STATUS_I8042_TRANS_UNKNOWN (HIDP_ERROR_CODES(0xC,9)) +#define HIDP_STATUS_INCOMPATIBLE_REPORT_ID (HIDP_ERROR_CODES(0xC,0xA)) +#define HIDP_STATUS_NOT_VALUE_ARRAY (HIDP_ERROR_CODES(0xC,0xB)) +#define HIDP_STATUS_IS_VALUE_ARRAY (HIDP_ERROR_CODES(0xC,0xC)) +#define HIDP_STATUS_DATA_INDEX_NOT_FOUND (HIDP_ERROR_CODES(0xC,0xD)) +#define HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE (HIDP_ERROR_CODES(0xC,0xE)) +#define HIDP_STATUS_BUTTON_NOT_PRESSED (HIDP_ERROR_CODES(0xC,0xF)) +#define HIDP_STATUS_REPORT_DOES_NOT_EXIST (HIDP_ERROR_CODES(0xC,0x10)) +#define HIDP_STATUS_NOT_IMPLEMENTED (HIDP_ERROR_CODES(0xC,0x20)) + +// +// We blundered this status code. +// +#define HIDP_STATUS_I8242_TRANS_UNKNOWN HIDP_STATUS_I8042_TRANS_UNKNOWN + +#include + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4115) +#pragma warning(default:4201) +#pragma warning(default:4214) +#endif + +#endif + diff --git a/setupapi-x64/hidsdi.h b/setupapi-x64/hidsdi.h new file mode 100644 index 0000000..8f97d75 --- /dev/null +++ b/setupapi-x64/hidsdi.h @@ -0,0 +1,494 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + HIDSDI.H + +Abstract: + + This module contains the PUBLIC definitions for the + code that implements the HID dll. + +Environment: + + Kernel & user mode + +--*/ + + +#ifndef _HIDSDI_H +#define _HIDSDI_H + +#include + +//#include "wtypes.h" + +//#include +//#include +//#include + +typedef LONG NTSTATUS; +#include "hidusage.h" +#include "hidpi.h" + +typedef struct _HIDD_CONFIGURATION { + PVOID cookie; + ULONG size; + ULONG RingBufferSize; +} HIDD_CONFIGURATION, *PHIDD_CONFIGURATION; + +typedef struct _HIDD_ATTRIBUTES { + ULONG Size; // = sizeof (struct _HIDD_ATTRIBUTES) + + // + // Vendor ids of this hid device + // + USHORT VendorID; + USHORT ProductID; + USHORT VersionNumber; + + // + // Additional fields will be added to the end of this structure. + // +} HIDD_ATTRIBUTES, *PHIDD_ATTRIBUTES; + +__checkReturn +BOOLEAN __stdcall +HidD_GetAttributes ( + __in HANDLE HidDeviceObject, + __out PHIDD_ATTRIBUTES Attributes + ); +/*++ +Routine Description: + Fill in the given HIDD_ATTRIBUTES structure with the attributes of the + given hid device. + +--*/ + + +void __stdcall +HidD_GetHidGuid ( + __out LPGUID HidGuid + ); + +__checkReturn +BOOLEAN __stdcall +HidD_GetPreparsedData ( + __in HANDLE HidDeviceObject, + __out __drv_when(return!=0, __drv_allocatesMem(Mem)) PHIDP_PREPARSED_DATA * PreparsedData + ); +/*++ +Routine Description: + Given a handle to a valid Hid Class Device Object, retrieve the preparsed + data for the device. This routine will allocate the appropriately + sized buffer to hold this preparsed data. It is up to client to call + HidP_FreePreparsedData to free the memory allocated to this structure when + it is no longer needed. + +Arguments: + HidDeviceObject A handle to a Hid Device that the client obtains using + a call to CreateFile on a valid Hid device string name. + The string name can be obtained using standard PnP calls. + + PreparsedData An opaque data structure used by other functions in this + library to retrieve information about a given device. + +Return Value: + TRUE if successful. + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +BOOLEAN __stdcall +HidD_FreePreparsedData ( + __in __drv_freesMem(Mem) PHIDP_PREPARSED_DATA PreparsedData + ); + +BOOLEAN __stdcall +HidD_FlushQueue ( + __in HANDLE HidDeviceObject + ); +/*++ +Routine Description: + Flush the input queue for the given HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device that the client obtains using + a call to CreateFile on a valid Hid device string name. + The string name can be obtained using standard PnP calls. + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_GetConfiguration ( + __in HANDLE HidDeviceObject, + __out_bcount(ConfigurationLength) PHIDD_CONFIGURATION Configuration, + __in ULONG ConfigurationLength + ); +/*++ +Routine Description: + Get the configuration information for this Hid device + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Configuration A configuration structure. HidD_GetConfiguration MUST + be called before the configuration can be modified and + set using HidD_SetConfiguration + + ConfigurationLength That is ``sizeof (HIDD_CONFIGURATION)''. Using this + parameter, we can later increase the length of the + configuration array and not break older apps. + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_SetConfiguration ( + __in HANDLE HidDeviceObject, + __in_bcount(ConfigurationLength) PHIDD_CONFIGURATION Configuration, + __in ULONG ConfigurationLength + ); +/*++ +Routine Description: + Set the configuration information for this Hid device... + + NOTE: HidD_GetConfiguration must be called to retrieve the current + configuration information before this information can be modified + and set. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Configuration A configuration structure. HidD_GetConfiguration MUST + be called before the configuration can be modified and + set using HidD_SetConfiguration + + ConfigurationLength That is ``sizeof (HIDD_CONFIGURATION)''. Using this + parameter, we can later increase the length of the + configuration array and not break older apps. + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_GetFeature ( + __in HANDLE HidDeviceObject, + __out_bcount(ReportBufferLength) PVOID ReportBuffer, + __in ULONG ReportBufferLength + ); +/*++ +Routine Description: + Retrieve a feature report from a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer that the feature report should be placed + into. The first byte of the buffer should be set to + the report ID of the desired report + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + FeatureReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_SetFeature ( + __in HANDLE HidDeviceObject, + __in_bcount(ReportBufferLength) PVOID ReportBuffer, + __in ULONG ReportBufferLength + ); +/*++ +Routine Description: + Send a feature report to a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer of the feature report to send to the device + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + FeatureReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ + +#if (NTDDI_VERSION >= NTDDI_WINXP) +__checkReturn +BOOLEAN __stdcall +HidD_GetInputReport ( + __in HANDLE HidDeviceObject, + __out_bcount(ReportBufferLength) PVOID ReportBuffer, + __in ULONG ReportBufferLength + ); +/*++ +Routine Description: + Retrieve an input report from a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer that the input report should be placed + into. The first byte of the buffer should be set to + the report ID of the desired report + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + InputReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_SetOutputReport ( + __in HANDLE HidDeviceObject, + __in_bcount(ReportBufferLength) PVOID ReportBuffer, + __in ULONG ReportBufferLength + ); +/*++ +Routine Description: + Send an output report to a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer of the output report to send to the device + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + OutputReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ + +#endif +__checkReturn +BOOLEAN __stdcall +HidD_GetNumInputBuffers ( + __in HANDLE HidDeviceObject, + __out PULONG NumberBuffers + ); +/*++ +Routine Description: + This function returns the number of input buffers used by the specified + file handle to the Hid device. Each file object has a number of buffers + associated with it to queue reports read from the device but which have + not yet been read by the user-mode app with a handle to that device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + NumberBuffers Number of buffers currently being used for this file + handle to the Hid device + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_SetNumInputBuffers ( + __in HANDLE HidDeviceObject, + __in ULONG NumberBuffers + ); +/*++ + +Routine Description: + This function sets the number of input buffers used by the specified + file handle to the Hid device. Each file object has a number of buffers + associated with it to queue reports read from the device but which have + not yet been read by the user-mode app with a handle to that device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + NumberBuffers New number of buffers to use for this file handle to + the Hid device + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_GetPhysicalDescriptor ( + __in HANDLE HidDeviceObject, + __out_bcount(BufferLength) PVOID Buffer, + __in ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the raw physical descriptor for the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the physical + descriptor if one exists for the specified device + handle + + BufferLength Length of buffer (in bytes) + + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_GetManufacturerString ( + __in HANDLE HidDeviceObject, + __out_bcount(BufferLength) PVOID Buffer, + __in ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the manufacturer string from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the manufacturer + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_GetProductString ( + __in HANDLE HidDeviceObject, + __out_bcount(BufferLength) PVOID Buffer, + __in ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the product string from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the product + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_GetIndexedString ( + __in HANDLE HidDeviceObject, + __in ULONG StringIndex, + __out_bcount(BufferLength) PVOID Buffer, + __in ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves a string from the specified Hid device that is + specified with a certain string index. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + StringIndex Index of the string to retrieve + + Buffer Buffer which on return will contain the product + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +__checkReturn +BOOLEAN __stdcall +HidD_GetSerialNumberString ( + __in HANDLE HidDeviceObject, + __out_bcount(BufferLength) PVOID Buffer, + __in ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the serial number string from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the serial number + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ + +#if (NTDDI_VERSION >= NTDDI_WINXP) +__checkReturn +BOOLEAN __stdcall +HidD_GetMsGenreDescriptor ( + __in HANDLE HidDeviceObject, + __out_bcount(BufferLength) PVOID Buffer, + __in ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the Microsoft Genre descriptor from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the descriptor + returned from the device. + + BufferLength Length of Buffer (in bytes) + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +#endif + + +#include + +#endif + diff --git a/setupapi-x64/hidusage.h b/setupapi-x64/hidusage.h new file mode 100644 index 0000000..331b109 --- /dev/null +++ b/setupapi-x64/hidusage.h @@ -0,0 +1,292 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + HIDUSAGE.H + +Abstract: + + Public Definitions of HID USAGES. + +Environment: + + Kernel & user mode + +--*/ + +#ifndef __HIDUSAGE_H__ +#define __HIDUSAGE_H__ + +// +// Usage Pages +// + +typedef USHORT USAGE, *PUSAGE; + +#define HID_USAGE_PAGE_UNDEFINED ((USAGE) 0x00) +#define HID_USAGE_PAGE_GENERIC ((USAGE) 0x01) +#define HID_USAGE_PAGE_SIMULATION ((USAGE) 0x02) +#define HID_USAGE_PAGE_VR ((USAGE) 0x03) +#define HID_USAGE_PAGE_SPORT ((USAGE) 0x04) +#define HID_USAGE_PAGE_GAME ((USAGE) 0x05) +#define HID_USAGE_PAGE_KEYBOARD ((USAGE) 0x07) +#define HID_USAGE_PAGE_LED ((USAGE) 0x08) +#define HID_USAGE_PAGE_BUTTON ((USAGE) 0x09) +#define HID_USAGE_PAGE_ORDINAL ((USAGE) 0x0A) +#define HID_USAGE_PAGE_TELEPHONY ((USAGE) 0x0B) +#define HID_USAGE_PAGE_CONSUMER ((USAGE) 0x0C) +#define HID_USAGE_PAGE_DIGITIZER ((USAGE) 0x0D) +#define HID_USAGE_PAGE_UNICODE ((USAGE) 0x10) +#define HID_USAGE_PAGE_ALPHANUMERIC ((USAGE) 0x14) + +// +// Microsoft Vendor Specific Usage Pages +// +#define HID_USAGE_PAGE_MICROSOFT_BLUETOOTH_HANDSFREE ((USAGE) 0xFFF3) + +// +// Usages from Generic Desktop Page (0x01) +// + +#define HID_USAGE_GENERIC_POINTER ((USAGE) 0x01) +#define HID_USAGE_GENERIC_MOUSE ((USAGE) 0x02) +#define HID_USAGE_GENERIC_JOYSTICK ((USAGE) 0x04) +#define HID_USAGE_GENERIC_GAMEPAD ((USAGE) 0x05) +#define HID_USAGE_GENERIC_KEYBOARD ((USAGE) 0x06) +#define HID_USAGE_GENERIC_KEYPAD ((USAGE) 0x07) +#define HID_USAGE_GENERIC_SYSTEM_CTL ((USAGE) 0x80) + +#define HID_USAGE_GENERIC_X ((USAGE) 0x30) +#define HID_USAGE_GENERIC_Y ((USAGE) 0x31) +#define HID_USAGE_GENERIC_Z ((USAGE) 0x32) +#define HID_USAGE_GENERIC_RX ((USAGE) 0x33) +#define HID_USAGE_GENERIC_RY ((USAGE) 0x34) +#define HID_USAGE_GENERIC_RZ ((USAGE) 0x35) +#define HID_USAGE_GENERIC_SLIDER ((USAGE) 0x36) +#define HID_USAGE_GENERIC_DIAL ((USAGE) 0x37) +#define HID_USAGE_GENERIC_WHEEL ((USAGE) 0x38) +#define HID_USAGE_GENERIC_HATSWITCH ((USAGE) 0x39) +#define HID_USAGE_GENERIC_COUNTED_BUFFER ((USAGE) 0x3A) +#define HID_USAGE_GENERIC_BYTE_COUNT ((USAGE) 0x3B) +#define HID_USAGE_GENERIC_MOTION_WAKEUP ((USAGE) 0x3C) +#define HID_USAGE_GENERIC_VX ((USAGE) 0x40) +#define HID_USAGE_GENERIC_VY ((USAGE) 0x41) +#define HID_USAGE_GENERIC_VZ ((USAGE) 0x42) +#define HID_USAGE_GENERIC_VBRX ((USAGE) 0x43) +#define HID_USAGE_GENERIC_VBRY ((USAGE) 0x44) +#define HID_USAGE_GENERIC_VBRZ ((USAGE) 0x45) +#define HID_USAGE_GENERIC_VNO ((USAGE) 0x46) +#define HID_USAGE_GENERIC_SYSCTL_POWER ((USAGE) 0x81) +#define HID_USAGE_GENERIC_SYSCTL_SLEEP ((USAGE) 0x82) +#define HID_USAGE_GENERIC_SYSCTL_WAKE ((USAGE) 0x83) +#define HID_USAGE_GENERIC_SYSCTL_CONTEXT_MENU ((USAGE) 0x84) +#define HID_USAGE_GENERIC_SYSCTL_MAIN_MENU ((USAGE) 0x85) +#define HID_USAGE_GENERIC_SYSCTL_APP_MENU ((USAGE) 0x86) +#define HID_USAGE_GENERIC_SYSCTL_HELP_MENU ((USAGE) 0x87) +#define HID_USAGE_GENERIC_SYSCTL_MENU_EXIT ((USAGE) 0x88) +#define HID_USAGE_GENERIC_SYSCTL_MENU_SELECT ((USAGE) 0x89) +#define HID_USAGE_GENERIC_SYSCTL_MENU_RIGHT ((USAGE) 0x8A) +#define HID_USAGE_GENERIC_SYSCTL_MENU_LEFT ((USAGE) 0x8B) +#define HID_USAGE_GENERIC_SYSCTL_MENU_UP ((USAGE) 0x8C) +#define HID_USAGE_GENERIC_SYSCTL_MENU_DOWN ((USAGE) 0x8D) + +// +// Usages from Simulation Controls Page (0x02) +// + +#define HID_USAGE_SIMULATION_RUDDER ((USAGE) 0xBA) +#define HID_USAGE_SIMULATION_THROTTLE ((USAGE) 0xBB) + +// +// Virtual Reality Controls Page (0x03) +// + + +// +// Sport Controls Page (0x04) +// + + +// +// Game Controls Page (0x05) +// + + +// +// Keyboard/Keypad Page (0x07) +// + + // Error "keys" +#define HID_USAGE_KEYBOARD_NOEVENT ((USAGE) 0x00) +#define HID_USAGE_KEYBOARD_ROLLOVER ((USAGE) 0x01) +#define HID_USAGE_KEYBOARD_POSTFAIL ((USAGE) 0x02) +#define HID_USAGE_KEYBOARD_UNDEFINED ((USAGE) 0x03) + + // Letters +#define HID_USAGE_KEYBOARD_aA ((USAGE) 0x04) +#define HID_USAGE_KEYBOARD_zZ ((USAGE) 0x1D) + // Numbers +#define HID_USAGE_KEYBOARD_ONE ((USAGE) 0x1E) +#define HID_USAGE_KEYBOARD_ZERO ((USAGE) 0x27) + // Modifier Keys +#define HID_USAGE_KEYBOARD_LCTRL ((USAGE) 0xE0) +#define HID_USAGE_KEYBOARD_LSHFT ((USAGE) 0xE1) +#define HID_USAGE_KEYBOARD_LALT ((USAGE) 0xE2) +#define HID_USAGE_KEYBOARD_LGUI ((USAGE) 0xE3) +#define HID_USAGE_KEYBOARD_RCTRL ((USAGE) 0xE4) +#define HID_USAGE_KEYBOARD_RSHFT ((USAGE) 0xE5) +#define HID_USAGE_KEYBOARD_RALT ((USAGE) 0xE6) +#define HID_USAGE_KEYBOARD_RGUI ((USAGE) 0xE7) +#define HID_USAGE_KEYBOARD_SCROLL_LOCK ((USAGE) 0x47) +#define HID_USAGE_KEYBOARD_NUM_LOCK ((USAGE) 0x53) +#define HID_USAGE_KEYBOARD_CAPS_LOCK ((USAGE) 0x39) + // Funtion keys +#define HID_USAGE_KEYBOARD_F1 ((USAGE) 0x3A) +#define HID_USAGE_KEYBOARD_F12 ((USAGE) 0x45) + +#define HID_USAGE_KEYBOARD_RETURN ((USAGE) 0x28) +#define HID_USAGE_KEYBOARD_ESCAPE ((USAGE) 0x29) +#define HID_USAGE_KEYBOARD_DELETE ((USAGE) 0x2A) + +#define HID_USAGE_KEYBOARD_PRINT_SCREEN ((USAGE) 0x46) + +// and hundreds more... + +// +// LED Page (0x08) +// + +#define HID_USAGE_LED_NUM_LOCK ((USAGE) 0x01) +#define HID_USAGE_LED_CAPS_LOCK ((USAGE) 0x02) +#define HID_USAGE_LED_SCROLL_LOCK ((USAGE) 0x03) +#define HID_USAGE_LED_COMPOSE ((USAGE) 0x04) +#define HID_USAGE_LED_KANA ((USAGE) 0x05) +#define HID_USAGE_LED_POWER ((USAGE) 0x06) +#define HID_USAGE_LED_SHIFT ((USAGE) 0x07) +#define HID_USAGE_LED_DO_NOT_DISTURB ((USAGE) 0x08) +#define HID_USAGE_LED_MUTE ((USAGE) 0x09) +#define HID_USAGE_LED_TONE_ENABLE ((USAGE) 0x0A) +#define HID_USAGE_LED_HIGH_CUT_FILTER ((USAGE) 0x0B) +#define HID_USAGE_LED_LOW_CUT_FILTER ((USAGE) 0x0C) +#define HID_USAGE_LED_EQUALIZER_ENABLE ((USAGE) 0x0D) +#define HID_USAGE_LED_SOUND_FIELD_ON ((USAGE) 0x0E) +#define HID_USAGE_LED_SURROUND_FIELD_ON ((USAGE) 0x0F) +#define HID_USAGE_LED_REPEAT ((USAGE) 0x10) +#define HID_USAGE_LED_STEREO ((USAGE) 0x11) +#define HID_USAGE_LED_SAMPLING_RATE_DETECT ((USAGE) 0x12) +#define HID_USAGE_LED_SPINNING ((USAGE) 0x13) +#define HID_USAGE_LED_CAV ((USAGE) 0x14) +#define HID_USAGE_LED_CLV ((USAGE) 0x15) +#define HID_USAGE_LED_RECORDING_FORMAT_DET ((USAGE) 0x16) +#define HID_USAGE_LED_OFF_HOOK ((USAGE) 0x17) +#define HID_USAGE_LED_RING ((USAGE) 0x18) +#define HID_USAGE_LED_MESSAGE_WAITING ((USAGE) 0x19) +#define HID_USAGE_LED_DATA_MODE ((USAGE) 0x1A) +#define HID_USAGE_LED_BATTERY_OPERATION ((USAGE) 0x1B) +#define HID_USAGE_LED_BATTERY_OK ((USAGE) 0x1C) +#define HID_USAGE_LED_BATTERY_LOW ((USAGE) 0x1D) +#define HID_USAGE_LED_SPEAKER ((USAGE) 0x1E) +#define HID_USAGE_LED_HEAD_SET ((USAGE) 0x1F) +#define HID_USAGE_LED_HOLD ((USAGE) 0x20) +#define HID_USAGE_LED_MICROPHONE ((USAGE) 0x21) +#define HID_USAGE_LED_COVERAGE ((USAGE) 0x22) +#define HID_USAGE_LED_NIGHT_MODE ((USAGE) 0x23) +#define HID_USAGE_LED_SEND_CALLS ((USAGE) 0x24) +#define HID_USAGE_LED_CALL_PICKUP ((USAGE) 0x25) +#define HID_USAGE_LED_CONFERENCE ((USAGE) 0x26) +#define HID_USAGE_LED_STAND_BY ((USAGE) 0x27) +#define HID_USAGE_LED_CAMERA_ON ((USAGE) 0x28) +#define HID_USAGE_LED_CAMERA_OFF ((USAGE) 0x29) +#define HID_USAGE_LED_ON_LINE ((USAGE) 0x2A) +#define HID_USAGE_LED_OFF_LINE ((USAGE) 0x2B) +#define HID_USAGE_LED_BUSY ((USAGE) 0x2C) +#define HID_USAGE_LED_READY ((USAGE) 0x2D) +#define HID_USAGE_LED_PAPER_OUT ((USAGE) 0x2E) +#define HID_USAGE_LED_PAPER_JAM ((USAGE) 0x2F) +#define HID_USAGE_LED_REMOTE ((USAGE) 0x30) +#define HID_USAGE_LED_FORWARD ((USAGE) 0x31) +#define HID_USAGE_LED_REVERSE ((USAGE) 0x32) +#define HID_USAGE_LED_STOP ((USAGE) 0x33) +#define HID_USAGE_LED_REWIND ((USAGE) 0x34) +#define HID_USAGE_LED_FAST_FORWARD ((USAGE) 0x35) +#define HID_USAGE_LED_PLAY ((USAGE) 0x36) +#define HID_USAGE_LED_PAUSE ((USAGE) 0x37) +#define HID_USAGE_LED_RECORD ((USAGE) 0x38) +#define HID_USAGE_LED_ERROR ((USAGE) 0x39) +#define HID_USAGE_LED_SELECTED_INDICATOR ((USAGE) 0x3A) +#define HID_USAGE_LED_IN_USE_INDICATOR ((USAGE) 0x3B) +#define HID_USAGE_LED_MULTI_MODE_INDICATOR ((USAGE) 0x3C) +#define HID_USAGE_LED_INDICATOR_ON ((USAGE) 0x3D) +#define HID_USAGE_LED_INDICATOR_FLASH ((USAGE) 0x3E) +#define HID_USAGE_LED_INDICATOR_SLOW_BLINK ((USAGE) 0x3F) +#define HID_USAGE_LED_INDICATOR_FAST_BLINK ((USAGE) 0x40) +#define HID_USAGE_LED_INDICATOR_OFF ((USAGE) 0x41) +#define HID_USAGE_LED_FLASH_ON_TIME ((USAGE) 0x42) +#define HID_USAGE_LED_SLOW_BLINK_ON_TIME ((USAGE) 0x43) +#define HID_USAGE_LED_SLOW_BLINK_OFF_TIME ((USAGE) 0x44) +#define HID_USAGE_LED_FAST_BLINK_ON_TIME ((USAGE) 0x45) +#define HID_USAGE_LED_FAST_BLINK_OFF_TIME ((USAGE) 0x46) +#define HID_USAGE_LED_INDICATOR_COLOR ((USAGE) 0x47) +#define HID_USAGE_LED_RED ((USAGE) 0x48) +#define HID_USAGE_LED_GREEN ((USAGE) 0x49) +#define HID_USAGE_LED_AMBER ((USAGE) 0x4A) +#define HID_USAGE_LED_GENERIC_INDICATOR ((USAGE) 0x4B) + +// +// Button Page (0x09) +// +// There is no need to label these usages. +// + + +// +// Ordinal Page (0x0A) +// +// There is no need to label these usages. +// + + +// +// Telephony Device Page (0x0B) +// + +#define HID_USAGE_TELEPHONY_PHONE ((USAGE) 0x01) +#define HID_USAGE_TELEPHONY_ANSWERING_MACHINE ((USAGE) 0x02) +#define HID_USAGE_TELEPHONY_MESSAGE_CONTROLS ((USAGE) 0x03) +#define HID_USAGE_TELEPHONY_HANDSET ((USAGE) 0x04) +#define HID_USAGE_TELEPHONY_HEADSET ((USAGE) 0x05) +#define HID_USAGE_TELEPHONY_KEYPAD ((USAGE) 0x06) +#define HID_USAGE_TELEPHONY_PROGRAMMABLE_BUTTON ((USAGE) 0x07) +#define HID_USAGE_TELEPHONY_REDIAL ((USAGE) 0x24) +#define HID_USAGE_TELEPHONY_TRANSFER ((USAGE) 0x25) +#define HID_USAGE_TELEPHONY_DROP ((USAGE) 0x26) +#define HID_USAGE_TELEPHONY_LINE ((USAGE) 0x2A) +#define HID_USAGE_TELEPHONY_RING_ENABLE ((USAGE) 0x2D) +#define HID_USAGE_TELEPHONY_SEND ((USAGE) 0x31) +#define HID_USAGE_TELEPHONY_KEYPAD_0 ((USAGE) 0xB0) +#define HID_USAGE_TELEPHONY_KEYPAD_D ((USAGE) 0xBF) +#define HID_USAGE_TELEPHONY_HOST_AVAILABLE ((USAGE) 0xF1) + + +// +// Microsoft Bluetooth Handsfree Page (0xFFF3) +// +#define HID_USAGE_MS_BTH_HF_DIALNUMBER ((USAGE) 0x21) +#define HID_USAGE_MS_BTH_HF_DIALMEMORY ((USAGE) 0x22) + + +// +// and others... +// + +#define HID_USAGE_CONSUMERCTRL ((USAGE)0x01) +#define HID_USAGE_DIGITIZER_PEN ((USAGE)0x02) +#define HID_USAGE_DIGITIZER_IN_RANGE ((USAGE)0x32) +#define HID_USAGE_DIGITIZER_TIP_SWITCH ((USAGE)0x42) +#define HID_USAGE_DIGITIZER_BARREL_SWITCH ((USAGE)0x44) + +#endif + + diff --git a/setupapi-x64/setupapi.dll b/setupapi-x64/setupapi.dll new file mode 100644 index 0000000..0331b84 Binary files /dev/null and b/setupapi-x64/setupapi.dll differ diff --git a/setupapi-x64/setupapi.lib b/setupapi-x64/setupapi.lib new file mode 100644 index 0000000..02f2981 Binary files /dev/null and b/setupapi-x64/setupapi.lib differ diff --git a/usb.cpp b/usb.cpp deleted file mode 100644 index 3307ac4..0000000 --- a/usb.cpp +++ /dev/null @@ -1,59 +0,0 @@ -#include "usb.h" -#include "QDebug" -#include - -usb::usb() { - // 初始化 libusb - if (libusb_init(&ctx) < 0) { - std::cerr << "Failed to initialize libusb!" << std::endl; - ctx = nullptr; - return; - } - qDebug() << "libusb initialized successfully!"; -} - -usb::~usb() { - - if (ctx) { - libusb_exit(ctx); - std::cout << "libusb deinitialized." << std::endl; - } - // listUsbDevices(); - - // libusb_exit(ctx); -} - -void usb::hello() -{ - qDebug() << "hello q!t"; -} - -void usb::listUsbDevices() { - libusb_device **devs; - // libusb_context *ctx = nullptr; - ssize_t cnt; - - if (libusb_init(&ctx) < 0) { - qDebug() << "Failed to initialize libusb"; - return; - } - - cnt = libusb_get_device_list(ctx, &devs); - if (cnt < 0) { - qDebug() << "No USB devices found!"; - } else { - qDebug() << "Found" << cnt << "USB devices."; - for (ssize_t i = 0; i < cnt; i++) { - libusb_device_descriptor desc; - if (libusb_get_device_descriptor(devs[i], &desc) == 0) { - qDebug() << "Device Found: VID =" << QString::number(desc.idVendor, 16) - << "PID =" << QString::number(desc.idProduct, 16); - } - } - } - - libusb_free_device_list(devs, 1); - // libusb_exit(ctx); -} - - diff --git a/usb.h b/usb.h deleted file mode 100644 index eb6dbfa..0000000 --- a/usb.h +++ /dev/null @@ -1,15 +0,0 @@ -#ifndef USB_H -#define USB_H -#include - -class usb -{ -public: - libusb_context *ctx; - usb(); - ~usb(); - void hello(); - void listUsbDevices(); -}; - -#endif // USB_H diff --git a/usb_interface.cpp b/usb_interface.cpp new file mode 100644 index 0000000..a376770 --- /dev/null +++ b/usb_interface.cpp @@ -0,0 +1,235 @@ +#include "usb_interface.h" +#include + + +#include +#include +#include +#include +#include + +extern "C"{ +#include +#include +#include +#include +#include +#include +#include "usbscan.h" +} + + +DEFINE_GUID (GUID_DEVINTERFACE_USBPRINT, 0x28d78fad, 0x5a12, 0x11d1, 0xae, 0x5b, 0x0, 0x0, 0xf8, 0x3, 0xa8, 0xc2); + +using namespace std; + +_USB_VAR USB_Var; +HANDLE hUsb = INVALID_HANDLE_VALUE; +char DeviceName[MAX_PATH]; +OVERLAPPED overlap; + + + +Usb_Interface::Usb_Interface() {} + +//USB获取当前的设备信息 +bool Usb_Interface::Usb_Exsit(uint16_t vid,uint16_t pid) +{ + // uint8_t vid_buf[8]; + // uint8_t pid_buf[8]; + + // //vid & pid 组合成字符串 + // sprintf((char *)(&vid_buf[0]),"vid_%04x",vid); + // sprintf((char *)(&pid_buf[0]),"pid_%04x",pid); + + // Get handle to the devices + HDEVINFO hInfo = SetupDiGetClassDevs((LPGUID)&GUID_DEVINTERFACE_USBPRINT, NULL, NULL, + DIGCF_PRESENT | DIGCF_INTERFACEDEVICE); + + if (hInfo == INVALID_HANDLE_VALUE) + { + return false; + } + + SP_INTERFACE_DEVICE_DATA Interface_Info; + Interface_Info.cbSize = sizeof(Interface_Info); // Enumerate device + if (!SetupDiEnumInterfaceDevice(hInfo, NULL, (LPGUID) &GUID_DEVINTERFACE_USBPRINT,0, &Interface_Info)) + { + SetupDiDestroyDeviceInfoList(hInfo); + return false; + } + + DWORD needed; // get the required length + SetupDiGetInterfaceDeviceDetail(hInfo, &Interface_Info, NULL, 0, &needed, NULL); + PSP_INTERFACE_DEVICE_DETAIL_DATA detail = (PSP_INTERFACE_DEVICE_DETAIL_DATA) malloc(needed); + if (!detail) + { + SetupDiDestroyDeviceInfoList(hInfo); + return false; + } + // fill the device details + detail->cbSize = sizeof(SP_INTERFACE_DEVICE_DETAIL_DATA); + if (!SetupDiGetInterfaceDeviceDetail(hInfo, &Interface_Info, detail, needed,NULL, NULL)) + { + free((PVOID) detail); + SetupDiDestroyDeviceInfoList(hInfo); + return false;; + } + + + char *ptr = (char *)(detail->DevicePath); + DevicePath = QString("PID:0x8800,VID:0x0fe6"); + memset(DeviceName,0x00,MAX_PATH); + for(int i = 0; i + +typedef struct +{ + bool SearchUSB; //是否搜索到了usb + bool UsbOpen; //usb是否打开 +}_USB_VAR; + +extern _USB_VAR USB_Var; + + +class Usb_Interface +{ + +public: + Usb_Interface(); + bool Usb_Exsit(uint16_t vid, uint16_t pid); //获取列表信息 + bool Usb_Open(uint16_t vid, uint16_t pid); //打开usb + bool Usb_Close(void); //关闭usb + bool Usb_Data_Send(LPCVOID lpBuffer, DWORD dwSize); //数据发送 + bool Usb_Data_Read(LPVOID lpBuffer, DWORD dwSize); //数据接收 + + uint16_t dev_vid; + uint16_t dev_pid; + QString DevicePath; +}; + +#endif // USB_INTERFACE_H