GetRegionData, fonction (wingdi.h)

Article
03/13/2024

La fonction GetRegionData remplit la mémoire tampon spécifiée avec des données décrivant une région. Ces données incluent les dimensions des rectangles qui composent la région.

Syntaxe

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

Paramètres

[in] hrgn

Handle de la région.

[in] nCount

Taille, en octets, de la mémoire tampon lpRgnData .

[out] lpRgnData

Pointeur vers une structure RGNDATA qui reçoit les informations. Les dimensions de la région sont en unités logiques. Si ce paramètre a la valeur NULL, la valeur de retour contient le nombre d’octets nécessaires pour les données de région.

Valeur retournée

Si la fonction réussit et que nCount spécifie un nombre adéquat d’octets, la valeur de retour est égale au nombre réel d’octets utilisés (inférieur ou égal à nCount).

Si lpRgnData a la valeur NULL, la valeur de retour est le nombre d’octets requis.

Si la fonction échoue, la valeur de retour est zéro.

Si l’échec est dû au fait que hrgn n’est pas valide, GetLastError retourne ERROR_INVALID_HANDLE. Sinon, GetLastError retourne ERROR_INVALID_PARAMETER .

Si nCount est trop petit, la fonction échoue.

Remarques

La fonction GetRegionData est utilisée conjointement avec la fonction ExtCreateRegion .

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	wingdi.h (inclure Windows.h)
Bibliothèque	Gdi32.lib
DLL	Gdi32.dll