HELPWININFOW-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 HELP_SETWINPOS-Wert aufruft.

Syntax

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

Member

wStructSize

Typ: int

Die Größe dieser Struktur in Bytes.

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 Pixeln.

dy

Typ: int

Die Höhe des Fensters in Pixel.

wMax

Typ: int

Optionen für die Anzeige des Fensters. Dies kann jeder der Werte sein, die im Parameter nCmdShow für die Funktion ShowWindow angegeben werden können.

rgchMember[2]

Typ: TCHAR[2]

Der Name des Fensters.

Hinweise

Die Windows-Hilfe unterteilt die Anzeige in 1024 Einheiten in X- und Y-Richtung. 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-Elemente und 512 für die dx - und dy-Elemente angeben.

Um wStructSize ordnungsgemäß zu berechnen, muss die tatsächliche Größe der Zeichenfolge bekannt sein, die bei rgchMember gespeichert werden soll. Da sizeof(HELPWININFO) definitionsgemäß zwei TCHARs enthält, müssen diese bei der endgültigen Gesamtsumme berücksichtigt werden. Das folgende Beispiel zeigt die ordnungsgemäße Berechnung einer instance 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;
}

Hinweis

Der winuser.h-Header definiert HELPWININFO 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)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Kopfzeile	winuser.h