SetupDiGetClassDevPropertySheetsA-Funktion (setupapi.h)

Die SetupDiGetClassDevPropertySheets-Funktion ruft Handles für die Eigenschaftenblätter 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 zugehörige Gerätesetupklasse 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 sein. Wenn dieser Parameter angegeben ist, ruft SetupDiGetClassDevPropertySheets die Eigenschaftenblätter-Handles 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ätesetupklasse zugeordnet sind.

[in] PropertySheetHeader

Ein Zeiger auf eine PROPERTYSHEETHEADER-Struktur. Im Abschnitt Hinweise finden Sie Informationen zum vom Aufrufer bereitgestellten Array von Eigenschaftenblatthandles, das dieser Struktur zugeordnet ist.

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ätesetupklasse des angegebenen Geräteinformationssatzes zugeordnet sind. Der Zeiger ist optional und kann NULL sein.

[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

Bei erfolgreicher Ausführung gibt die Funktion TRUE zurück. Andernfalls gibt die Funktion FALSE zurück. Rufen Sie GetLastError auf, um den Fehlercode abzurufen.

Hinweise

Eine PROPERTYSHEETHEADER-Struktur enthält zwei Member, die einem vom Aufrufer bereitgestellten Array zugeordnet sind, das die Funktion verwendet, um die Handles von Eigenschaftenblättern zurückzugeben. Das phpages-Element ist ein Zeiger auf ein vom Aufrufer bereitgestelltes Array von Eigenschaftenblatthandles, und der Eingabewert des nPages-Members gibt die Anzahl der Handles an, die bereits im Handle-Array enthalten sind. Die Funktion fügt dem Handle-Array beginnend mit dem Arrayelement, dessen Arrayindex der Eingabewert von nPages ist, Eigenschaftentabellen hinzu. Die Funktion fügt dem Array Handles in aufeinanderfolgender 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 wie folgt ausgeführt:

• Fügt die Handles dem Handle-Array hinzu.
• Legt nPages auf die Gesamtzahl der Handles im Array fest.
• Legt RequiredSize auf die Anzahl der zurückgegebenen Handles fest.
• Gibt TRUE zurück.

Wenn das Handle-Array nicht groß genug ist, um die Handles aller angegebenen Eigenschaftenblattseiten zu enthalten, wird die Funktion wie folgt ausgeführt:

• Fügt so viele Handles hinzu, wie das Array enthalten kann.
• Legt nPages auf PropertySheetHeaderPageListSize fest.
• Legt RequiredSize auf die Gesamtzahl 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.

Hinweis

Der setupapi.h-Header 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 nicht codierungsneutralem Code 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
Unterstützte Mindestversion (Client)	Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows.
Zielplattform	Desktop
Kopfzeile	setupapi.h (einschließlich Setupapi.h)
Bibliothek	Setupapi.lib

Weitere Informationen

SP_DEVINFO_DATA