GetRegionData-Funktion (wingdi.h)

Artikel
03/04/2024

Die GetRegionData-Funktion füllt den angegebenen Puffer mit Daten, die einen Bereich beschreiben. Diese Daten enthalten die Dimensionen der Rechtecke, aus denen der Bereich besteht.

Syntax

DWORD GetRegionData(
  [in]  HRGN      hrgn,
  [in]  DWORD     nCount,
  [out] LPRGNDATA lpRgnData
);

Parameter

[in] hrgn

Ein Handle für die Region.

[in] nCount

Die Größe des lpRgnData-Puffers in Bytes.

[out] lpRgnData

Ein Zeiger auf eine RGNDATA-Struktur , die die Informationen empfängt. Die Dimensionen des Bereichs sind in logischen Einheiten enthalten. Wenn dieser Parameter NULL ist, enthält der Rückgabewert die Anzahl der Bytes, die für die Regionsdaten erforderlich sind.

Rückgabewert

Wenn die Funktion erfolgreich ist und nCount eine angemessene Anzahl von Bytes angibt, entspricht der Rückgabewert der tatsächlichen Anzahl verwendeter Bytes (kleiner oder gleich nCount).

Wenn lpRgnDataNULL ist, ist der Rückgabewert die erforderliche Anzahl von Bytes.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null.

Wenn der Fehler darauf zurückzuführen ist, dass hrgn ungültig ist, gibt GetLastErrorERROR_INVALID_HANDLE zurück. Andernfalls gibt GetLastErrorERROR_INVALID_PARAMETER zurück.

Wenn nCount zu klein ist, schlägt die Funktion fehl.

Hinweise

Die GetRegionData-Funktion wird in Verbindung mit der Funktion ExtCreateRegion verwendet.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	wingdi.h (windows.h einschließen)
Bibliothek	Gdi32.lib
DLL	Gdi32.dll