Estructura HELPWININFOA (winuser.h)

Contiene el tamaño y la posición de una ventana de Ayuda principal o secundaria. Una aplicación puede establecer esta información llamando a la función WinHelp con el valor HELP_SETWINPOS.

Sintaxis

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

Miembros

wStructSize

Tipo: int

Tamaño de esta estructura, en bytes.

x

Tipo: int

Coordenada X de la esquina superior izquierda de la ventana, en coordenadas de pantalla.

y

Tipo: int

Coordenada Y de la esquina superior izquierda de la ventana, en coordenadas de pantalla.

dx

Tipo: int

Ancho de la ventana en píxeles.

dy

Tipo: int

Alto de la ventana, en píxeles.

wMax

Tipo: int

Opciones para mostrar la ventana. Puede ser cualquiera de los valores que se pueden especificar en el parámetro nCmdShow para la función ShowWindow.

rgchMember[2]

Tipo: TCHAR[2]

Nombre de la ventana.

Comentarios

La Ayuda de Windows divide la pantalla en 1024 unidades en las direcciones X e Y. Para crear una ventana secundaria que rellene el cuadrante superior izquierdo de la pantalla, por ejemplo, una aplicación especificaría cero para los miembrosx e y y para los miembros dx y dy.

Para calcular wStructSize correctamente, se debe conocer el tamaño real de la cadena que se va a almacenar en rgchMember . Dado que sizeof(HELPWININFO) incluye dos TCHAR por definición, deben tenerse en cuenta en el total final. En el ejemplo siguiente se muestra el cálculo adecuado de una instancia 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;
}

Nota

El encabezado winuser.h define HELPWININFO como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	winuser.h