SetupDiGetClassDevPropertySheetsA-Funktion (setupapi.h)
Die SetupDiGetClassDevPropertySheets Funktion ruft Handles zu den Eigenschaftenblättern eines Geräteinformationselements oder der Geräteeinrichtungsklasse eines Geräteinformationssatzes ab.
Syntax
WINSETUPAPI BOOL SetupDiGetClassDevPropertySheetsA(
[in] HDEVINFO DeviceInfoSet,
[in, optional] PSP_DEVINFO_DATA DeviceInfoData,
[in] LPPROPSHEETHEADERA PropertySheetHeader,
[in] DWORD PropertySheetHeaderPageListSize,
[out, optional] PDWORD RequiredSize,
[in] DWORD PropertySheetType
);
Parameter
[in] DeviceInfoSet
Ein Handle für den Geräteinformationssatz, für den Eigenschaftenblatthandles zurückgegeben werden sollen. Wenn DeviceInfoData- kein Geräteinformationselement im Geräteinformationssatz angibt, muss der Geräteinformationssatz über eine zugeordnete Geräteeinrichtungsklasse verfügen.
[in, optional] DeviceInfoData
Ein Zeiger auf eine SP_DEVINFO_DATA Struktur, die ein Geräteinformationselement in DeviceInfoSet angibt.
Dieser Parameter ist optional und kann NULL-werden. Wenn dieser Parameter angegeben ist, ruft SetupDiGetClassDevPropertySheets die Eigenschaftenblätter ab, die dem angegebenen Gerät zugeordnet sind. Wenn dieser Parameter NULL-ist, ruft SetupDiGetClassDevPropertySheets die Eigenschaftenblätter ab, die der in DeviceInfoSet-angegebenen Geräteeinrichtungsklasse zugeordnet sind.
[in] PropertySheetHeader
Ein Zeiger auf eine PROPERTYSHEETHEADER-Struktur. Informationen zum vom Aufrufer bereitgestellten Array von Eigenschaftenblatthandles, die dieser Struktur zugeordnet sind, finden Sie im Abschnitt Anmerkungen Abschnitt.
Weitere Dokumentationen zu diesen Struktur- und Eigenschaftenblättern im Allgemeinen finden Sie im Microsoft Windows SDK.
[in] PropertySheetHeaderPageListSize
Die maximale Anzahl von Handles, die das vom Aufrufer bereitgestellte Array von Eigenschaftenblatthandles enthalten kann.
[out, optional] RequiredSize
Ein Zeiger auf eine Variable vom Typ DWORD, die die Anzahl der Eigenschaftenblätter empfängt, die dem angegebenen Geräteinformationselement oder der Geräteeinrichtungsklasse des angegebenen Geräteinformationssatzes zugeordnet sind. Der Zeiger ist optional und kann NULL-werden.
[in] PropertySheetType
Ein Flag, das einen der folgenden Typen von Eigenschaftenblättern angibt.
| Eigenschaftenblatttyp | Bedeutung |
|---|---|
| DIGCDP_FLAG_ADVANCED | Erweiterte Eigenschaftenblätter. |
| DIGCDP_FLAG_BASIC | Grundlegende Eigenschaftenblätter. Wird nur in Microsoft Windows 95 und Windows 98 unterstützt. Verwenden Sie nicht in Windows 2000 und höheren Versionen von Windows. |
| DIGCDP_FLAG_REMOTE_ADVANCED | Erweiterte Eigenschaftenblätter auf einem Remotecomputer. |
Rückgabewert
Die Funktion gibt bei erfolgreicher Ausführung TRUE zurück. Andernfalls gibt die Funktion FALSEzurück. Rufen Sie GetLastError- auf, um den Fehlercode abzurufen.
Bemerkungen
Eine PROPERTYSHEETHEADER-Struktur enthält zwei Elemente, die einem vom Aufrufer bereitgestellten Array zugeordnet sind, das von der Funktion verwendet wird, um die Handles von Eigenschaftenblättern zurückzugeben. Das phpages Member ist ein Zeiger auf ein vom Aufrufer bereitgestelltes Array von Eigenschaftenblatthandles, und der Eingabewert des nPages Member gibt die Anzahl der Handles an, die bereits im Handlearray enthalten sind. Die Funktion fügt eigenschaftenblatthandles zum Handlearray beginnend mit dem Arrayelement hinzu, dessen Arrayindex der Eingabewert von nPagesist. Die Funktion fügt dem Array Ziehpunkte in aufeinander folgender Reihenfolge hinzu, bis entweder das Array voll ist oder die Handles aller angeforderten Eigenschaftenblattseiten dem Array hinzugefügt wurden. Die maximale Anzahl von Eigenschaftenblatthandles, die die Funktion zurückgeben kann, ist gleich (PropertySheetHeaderPageListSize - (Eingabewert von nPages)).
Wenn das Handlearray groß genug ist, um die Handles aller angeforderten Eigenschaftenblattseiten zu enthalten, wird die Funktion:
- Fügt dem Handlearray die Ziehpunkte hinzu.
- Legt nPages- auf die Gesamtanzahl der Ziehpunkte im Array fest.
- Legt RequiredSize- auf die Anzahl der zurückgegebenen Handles fest.
- Gibt TRUE-zurück.
- Fügt so viele Ziehpunkte hinzu, wie das Array enthalten kann.
- Legt nPages- auf PropertySheetHeaderPageListSize-fest.
- Legt RequiredSize- auf die Gesamtanzahl der angeforderten Eigenschaftenblattseiten fest. Die Anzahl der Handles, die nicht von der Funktion zurückgegeben werden, ist gleich (RequiredSize - PropertySheetHeaderPageListSize - (Eingabewert von nPages)).
- Legt den Fehlercode auf ERROR_INSUFFICIENT_BUFFER fest.
- Gibt FALSE-zurück.
Anmerkung
Der Header setupapi.h definiert SetupDiGetClassDevPropertySheets als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows. |
| Zielplattform- | Desktop |
| Header- | setupapi.h (include Setupapi.h) |
| Library | Setupapi.lib |