struktur HIDP_VALUE_CAPS (hidpi.h)

Artikel
03/05/2024

Struktur HIDP_VALUE_CAPS berisi informasi yang menjelaskan kemampuan sekumpulan nilai kontrol HID (baik penggunaan tunggal atau rentang penggunaan).

Sintaks

typedef struct _HIDP_VALUE_CAPS {
  USAGE   UsagePage;
  UCHAR   ReportID;
  BOOLEAN IsAlias;
  USHORT  BitField;
  USHORT  LinkCollection;
  USAGE   LinkUsage;
  USAGE   LinkUsagePage;
  BOOLEAN IsRange;
  BOOLEAN IsStringRange;
  BOOLEAN IsDesignatorRange;
  BOOLEAN IsAbsolute;
  BOOLEAN HasNull;
  UCHAR   Reserved;
  USHORT  BitSize;
  USHORT  ReportCount;
  USHORT  Reserved2[5];
  ULONG   UnitsExp;
  ULONG   Units;
  LONG    LogicalMin;
  LONG    LogicalMax;
  LONG    PhysicalMin;
  LONG    PhysicalMax;
  union {
    struct {
      USAGE  UsageMin;
      USAGE  UsageMax;
      USHORT StringMin;
      USHORT StringMax;
      USHORT DesignatorMin;
      USHORT DesignatorMax;
      USHORT DataIndexMin;
      USHORT DataIndexMax;
    } Range;
    struct {
      USAGE  Usage;
      USAGE  Reserved1;
      USHORT StringIndex;
      USHORT Reserved2;
      USHORT DesignatorIndex;
      USHORT Reserved3;
      USHORT DataIndex;
      USHORT Reserved4;
    } NotRange;
  };
} HIDP_VALUE_CAPS, *PHIDP_VALUE_CAPS;

Anggota

UsagePage

Menentukan halaman penggunaan rentang penggunaan atau penggunaan.

ReportID

Menentukan ID laporan dari laporan HID yang berisi penggunaan atau rentang penggunaan.

IsAlias

Menunjukkan, jika TRUE, bahwa penggunaan adalah anggota dari sekumpulan penggunaan alias. Jika tidak, jika IsAliasFALSE, nilainya hanya memiliki satu penggunaan.

BitField

Berisi bidang data (satu atau dua byte) yang terkait dengan item utama input, output, atau fitur.

LinkCollection

Menentukan indeks koleksi tautan dalam array pengumpulan tautan koleksi tingkat atas yang berisi penggunaan atau rentang penggunaan. Jika LinkCollection adalah nol, rentang penggunaan atau penggunaan terkandung dalam koleksi tingkat atas.

LinkUsage

Menentukan penggunaan kumpulan tautan yang berisi rentang penggunaan atau penggunaan. Jika LinkCollection nol, LinkUsage menentukan penggunaan koleksi tingkat atas.

LinkUsagePage

Menentukan halaman penggunaan kumpulan tautan yang berisi rentang penggunaan atau penggunaan. Jika LinkCollection adalah nol, LinkUsagePage menentukan halaman penggunaan koleksi tingkat atas.

IsRange

Menentukan, jika TRUE, struktur tersebut menjelaskan rentang penggunaan. Jika tidak, jika IsRangefalse, struktur menjelaskan satu penggunaan.

IsStringRange

Menentukan, jika TRUE, bahwa rentang penggunaan atau penggunaan memiliki sekumpulan deskriptor string. Jika tidak, jika IsStringRangefalse, rentang penggunaan atau penggunaan memiliki nol atau satu deskriptor string.

IsDesignatorRange

Menentukan, jika TRUE, bahwa rentang penggunaan atau penggunaan memiliki sekumpulan penanda. Jika tidak, jika IsDesignatorRangeADALAH FALSE, rentang penggunaan atau penggunaan memiliki nol atau satu penunjuk.

IsAbsolute

Menentukan, jika TRUE, bahwa rentang penggunaan atau penggunaan menyediakan data absolut. Jika tidak, jika IsAbsoluteadalah FALSE, nilainya adalah perubahan status dari nilai sebelumnya.

HasNull

Menentukan, jika TRUE, bahwa penggunaan mendukung nilai NULL , yang menunjukkan bahwa data tidak valid dan harus diabaikan. Jika tidak, jika HasNulladalah FALSE, penggunaan tidak memiliki nilai NULL .

Reserved

Dicadangkan untuk penggunaan sistem internal.

BitSize

Menentukan ukuran, dalam bit, dari bidang data penggunaan dalam laporan. Jika ReportCount lebih besar dari satu, setiap penggunaan memiliki bidang data terpisah dengan ukuran ini.

ReportCount

Menentukan jumlah penggunaan yang dijelaskan struktur ini.

Reserved2[5]

Dicadangkan untuk penggunaan sistem internal.

UnitsExp

Menentukan eksponen penggunaan, seperti yang dijelaskan oleh standar USB HID.

Units

Menentukan unit penggunaan, seperti yang dijelaskan oleh USB HID Standard.

LogicalMin

Menentukan batas bawah penggunaan yang ditandatangani.

LogicalMax

Menentukan batas atas penggunaan yang ditandatangani.

PhysicalMin

Menentukan batas bawah yang ditandatangani penggunaan setelah penskalakan diterapkan ke nilai minimum logis.

PhysicalMax

Menentukan batas atas penggunaan yang ditandatangani setelah penskalaan diterapkan ke nilai maksimum logis.

Range

Menentukan, jika IsRangeTRUE, informasi tentang rentang penggunaan. Jika tidak, jika IsRangeFALSE, NotRange berisi informasi tentang satu penggunaan.

Range.UsageMin

Menunjukkan batas bawah inklusif rentang penggunaan yang batas atas inklusifnya ditentukan oleh Range.UsageMax.

Range.UsageMax

Menunjukkan batas atas inklusif dari rentang penggunaan yang batas bawah inklusifnya ditunjukkan oleh Range.UsageMin.

Range.StringMin

Menunjukkan batas bawah inklusif dari rentang deskriptor string (ditentukan oleh item minimum string dan maksimum string) yang batas atas inklusifnya ditunjukkan oleh Range.StringMax.

Range.StringMax

Menunjukkan batas atas inklusif dari rentang deskriptor string (ditentukan oleh item minimum string dan maksimum string) yang batas bawah inklusifnya ditunjukkan oleh Range.StringMin.

Range.DesignatorMin

Menunjukkan batas bawah inklusif dari rentang penunjuk (ditentukan oleh item minimum penunjuk dan maksimum penunjuk) yang batas bawah inklusifnya ditunjukkan oleh Range.DesignatorMax.

Range.DesignatorMax

Menunjukkan batas atas inklusif dari rentang penunjuk (ditentukan oleh item minimum penunjuk dan maksimum penunjuk) yang batas bawah inklusifnya ditunjukkan oleh Range.DesignatorMin.

Range.DataIndexMin

Menunjukkan batas bawah inklusif dari rentang berurutan indeks data yang sesuai, satu-ke-satu dan dalam urutan yang sama, ke penggunaan yang ditentukan oleh rentang penggunaan Range.UsageMin ke Range.UsageMax.

Range.DataIndexMax

Menunjukkan batas atas inklusif dari rentang indeks data berurutan yang sesuai, satu-ke-satu dan dalam urutan yang sama, ke penggunaan yang ditentukan oleh rentang penggunaan Range.UsageMin ke Range.UsageMax.

NotRange

Menentukan, jika IsRangeFALSE, informasi tentang satu penggunaan. Jika tidak, jika IsRangeTRUE, Rentang berisi informasi tentang rentang penggunaan.

NotRange.Usage

Menunjukkan ID penggunaan.

NotRange.Reserved1

Dicadangkan untuk penggunaan sistem internal.

NotRange.StringIndex

Menunjukkan ID deskriptor string untuk penggunaan yang ditentukan oleh NotRange.Usage.

NotRange.Reserved2

Dicadangkan untuk penggunaan sistem internal.

NotRange.DesignatorIndex

Menunjukkan ID penunjuk untuk penggunaan yang ditentukan oleh NotRange.Usage.

NotRange.Reserved3

Dicadangkan untuk penggunaan sistem internal.

NotRange.DataIndex

Menunjukkan indeks data penggunaan yang ditentukan oleh NotRange.Usage.

NotRange.Reserved4

Dicadangkan untuk penggunaan sistem internal.

Keterangan

Klien mendapatkan array kemampuan nilai dengan memanggil HidP_GetValueCaps atau HidP_GetSpecificValueCaps. Rutinitas ini mengembalikan array struktur HIDP_VALUE_CAPS dalam buffer yang dialokasikan pemanggil. Panjang buffer yang diperlukan ditentukan dalam struktur HIDP_CAPS yang dikembalikan oleh HidP_GetCaps.

Untuk informasi tentang kemampuan nilai kontrol HID, lihat Kemampuan Koleksi dan Array Kemampuan Nilai.