SetupDiGetDeviceInterfacePropertyKeys-Funktion (setupapi.h)

Die SetupDiGetDeviceInterfacePropertyKeys-Funktion ruft ein Array von Geräteeigenschaftenschlüsseln ab, die die Geräteeigenschaften darstellen, die für eine Geräteschnittstelle festgelegt sind.

Syntax

WINSETUPAPI BOOL SetupDiGetDeviceInterfacePropertyKeys(
  [in]            HDEVINFO                  DeviceInfoSet,
  [in]            PSP_DEVICE_INTERFACE_DATA DeviceInterfaceData,
  [out, optional] DEVPROPKEY                *PropertyKeyArray,
  [in]            DWORD                     PropertyKeyCount,
  [out, optional] PDWORD                    RequiredPropertyKeyCount,
  [in]            DWORD                     Flags
);

Parameter

[in] DeviceInfoSet

Ein Handle für einen Geräteinformationssatz. Dieser Geräteinformationssatz enthält eine Geräteschnittstelle, für die ein Array der Geräteeigenschaftenschlüssel abgerufen werden soll, die die geräteeigenschaften darstellen, die für eine Geräteschnittstelle festgelegt sind.

[in] DeviceInterfaceData

Ein Zeiger auf eine SP_DEVICE_INTERFACE_DATA Struktur, die die Geräteschnittstelle darstellt, für die das angeforderte Array von Geräteeigenschaftenschlüsseln abgerufen werden soll.

[out, optional] PropertyKeyArray

Ein Zeiger auf einen Puffer, der ein Array von DEVPROPKEY-typisierten Werten empfängt, wobei jeder Wert ein Geräteeigenschaftsschlüssel für eine Geräteeigenschaft ist, die für die Geräteschnittstelle festgelegt ist. Der Zeiger ist optional und kann NULL sein. Weitere Informationen finden Sie im Abschnitt Hinweise weiter unten in diesem Thema.

[in] PropertyKeyCount

Die Größe des PropertyKeyArray-Puffers in DEVPROPKEY-typisierten Elementen. Wenn PropertyKeyArrayNULL ist, muss PropertyKeyCount auf 0 festgelegt werden.

[out, optional] RequiredPropertyKeyCount

Ein Zeiger auf eine DWORD-typisierte Variable, die die Anzahl der angeforderten Geräteeigenschaftsschlüssel empfängt. Der Zeiger ist optional und kann auf NULL festgelegt werden.

[in] Flags

Dieser Parameter muss auf 0 festgelegt werden.

Rückgabewert

Die Funktion gibt TRUE zurück, wenn sie erfolgreich ist. Andernfalls wird FALSE zurückgegeben, und der protokollierte Fehler kann durch Aufrufen von GetLastError abgerufen werden.

Die folgende Tabelle enthält einige der häufigeren Fehlercodes, die diese Funktion möglicherweise protokolliert.

Rückgabecode	Beschreibung
ERROR_INVALID_FLAGS	Der Wert von Flags ist nicht 0 (null).
ERROR_INVALID_HANDLE	Der von DevInfoSet angegebene Geräteinformationssatz ist ungültig.
ERROR_INVALID_DATA	Ein interner Datenwert ist ungültig.
ERROR_INVALID_PARAMETER	Ein Parameter ist nicht gültig. Eine Möglichkeit besteht darin, dass die von DevInterfaceData angegebene Geräteschnittstelle ungültig ist.
ERROR_INVALID_USER_BUFFER	Ein Benutzerpuffer ist ungültig. Eine Möglichkeit besteht darin, dass PropertyKeyArrayNULL und PropertKeyCount nicht null ist. .
ERROR_NO_SUCH_DEVICE_INTERFACE	Die von DeviceInterfaceData angegebene Geräteschnittstelle ist nicht vorhanden.
ERROR_INSUFFICIENT_BUFFER	Der PropertyKeyArray-Puffer ist nicht groß genug, um alle angeforderten Eigenschaftenschlüssel aufzunehmen.
ERROR_NOT_ENOUGH_MEMORY	Es war nicht genügend Systemspeicher verfügbar, um den Vorgang abzuschließen.

Hinweise

SetupDiGetDeviceInterfacePropertyKeys ist Teil des einheitlichen Geräteeigenschaftenmodells.

Wenn der PropertyKeyArray-Puffer nicht groß genug ist, um alle angeforderten Eigenschaftsschlüssel zu speichern, ruft SetupDiGetDeviceInterfacePropertyKeys keine Eigenschaftsschlüssel ab und gibt ERROR_INSUFFICIENT_BUFFER zurück. Wenn der Aufrufer einen RequiredPropertyKeyCount-Zeiger angegeben hat, legt SetupDiGetDeviceInterfacePropertyKeys den Wert von *RequiredPropertyKeyCount auf die erforderliche Größe in DEVPROPKEY-typisierten Werten des PropertyKeyArray-Puffers fest.

Um eine Geräteschnittstelleneigenschaft abzurufen, rufen Sie SetupDiGetDeviceInterfaceProperty auf, und um eine Geräteschnittstelleneigenschaft festzulegen, rufen Sie SetupDiSetDeviceInterfaceProperty auf.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows Vista und späteren Windows-Versionen.
Zielplattform	DesktopFür universal rufen Sie CM_Get_Device_Interface_Property_Keys auf.
Kopfzeile	setupapi.h (schließen Sie Setupapi.h ein)
Bibliothek	Setupapi.lib
DLL	Setupapi.dll

Weitere Informationen

SetupDiGetDeviceInterfaceProperty

SetupDiSetDeviceInterfaceProperty