Structure HELPWININFOW (winuser.h)

Contient la taille et la position d’une fenêtre d’aide principale ou secondaire. Une application peut définir ces informations en appelant la fonction WinHelp avec la valeur HELP_SETWINPOS.

Syntaxe

typedef struct tagHELPWININFOW {
  int   wStructSize;
  int   x;
  int   y;
  int   dx;
  int   dy;
  int   wMax;
  WCHAR rgchMember[2];
} HELPWININFOW, *PHELPWININFOW, *LPHELPWININFOW;

Membres

wStructSize

Type : int

Taille de cette structure, en octets.

x

Type : int

Coordonnée X du coin supérieur gauche de la fenêtre, dans les coordonnées de l’écran.

y

Type : int

Coordonnée Y du coin supérieur gauche de la fenêtre, dans les coordonnées de l’écran.

dx

Type : int

Largeur de la fenêtre, en pixels.

dy

Type : int

Hauteur de la fenêtre, en pixels.

wMax

Type : int

Options d’affichage de la fenêtre. Il peut s’agir de l’une des valeurs spécifiées dans le paramètre nCmdShow de la fonction ShowWindow.

rgchMember[2]

Type : TCHAR[2]

Nom de la fenêtre.

Remarques

L’aide de Windows divise l’affichage en unités 1024 dans les directions X et Y. Pour créer une fenêtre secondaire qui remplit le quadrant supérieur gauche de l’affichage, par exemple, une application spécifie zéro pour les membres x et y et 512 pour les membres dx et dy .

Pour calculer correctement wStructSize , la taille réelle de la chaîne à stocker sur rgchMember doit être connue. Étant donné que sizeof(HELPWININFO) inclut deux TCHAR par définition, ils doivent être pris en compte dans le total final. L’exemple suivant montre le calcul correct d’une instance de wStructSize.

WORD wSize;
TCHAR *szWndName = TEXT("wnd_menu"); 
size_t NameLength;  
HRESULT hr;
HELPWININFO hwi;

// StringCbLength returns the length of the string without 
// the terminating null character.
hr = StringCbLength(szWndName, STRSAFE_MAX_CCH * sizeof(TCHAR), &NameLength);
    
if (SUCCEEDED(hr))
{
    // Add bytes to account for the name string's terminating null character.
    NameLength + sizeof(TCHAR);
    
    // Determine the size of HELPWININFO without the TCHAR array.
    wSize = sizeof(HELPWININFO) - (2 * sizeof(TCHAR));
    
    // Determine the total size of the final HELPWININFO structure.
    hwi.wStructSize = wSize + NameLength;
}

Notes

L’en-tête winuser.h définit HELPWININFO comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
En-tête	winuser.h