HELPWININFOA-Struktur (winuser.h)

Enthält die Größe und Position eines primären oder sekundären Hilfefensters. Eine Anwendung kann diese Informationen festlegen, indem sie die WinHelp--Funktion mit dem wert HELP_SETWINPOS aufrufen.

Syntax

typedef struct tagHELPWININFOA {
  int  wStructSize;
  int  x;
  int  y;
  int  dx;
  int  dy;
  int  wMax;
  CHAR rgchMember[2];
} HELPWININFOA, *PHELPWININFOA, *LPHELPWININFOA;

Angehörige

wStructSize

Typ: int

Die Größe dieser Struktur in Byte.

x

Typ: int

X-Koordinate der oberen linken Ecke des Fensters in Bildschirmkoordinaten.

y

Typ: int

Y-Koordinate der oberen linken Ecke des Fensters in Bildschirmkoordinaten.

dx

Typ: int

Die Breite des Fensters in Pixel.

dy

Typ: int

Die Höhe des Fensters in Pixel.

wMax

Typ: int

Optionen für die Anzeige des Fensters. Dabei kann es sich um einen beliebigen Wert handeln, der im nCmdShow Parameter für die ShowWindow--Funktion angegeben werden kann.

rgchMember[2]

Typ: TCHAR[2]

Der Name des Fensters.

Bemerkungen

Die Windows-Hilfe teilt die Anzeige in 1024 Einheiten in die X- und Y-Richtung auf. Um ein sekundäres Fenster zu erstellen, das den oberen linken Quadranten der Anzeige ausfüllt, würde beispielsweise eine Anwendung null für die x und y Member und 512 für die dx und dy-Member angeben.

Um wStructS ize ordnungsgemäß zu berechnen, muss die tatsächliche Größe der Zeichenfolge, die bei rgchMember gespeichert werden soll, bekannt sein. Da Größe der(HELPWININFO) zwei TCHARs enthält, müssen sie in der Endsumme berücksichtigt werden. Das folgende Beispiel zeigt die ordnungsgemäße Berechnung einer Instanz von 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;
}

Anmerkung

Der winuser.h-Header definiert HELPWININFO als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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-	Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Header-	winuser.h