Estrutura HELPWININFOA (winuser.h)

Contém o tamanho e a posição de uma janela de Ajuda primária ou secundária. Um aplicativo pode definir essas informações chamando a função WinHelp com o valor HELP_SETWINPOS.

Sintaxe

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

Membros

wStructSize

Tipo: int

O tamanho dessa estrutura, em bytes.

x

Tipo: int

Coordenada X do canto superior esquerdo da janela, em coordenadas de tela.

y

Tipo: int

Coordenada Y do canto superior esquerdo da janela, em coordenadas de tela.

dx

Tipo: int

A largura da janela, em pixels.

dy

Tipo: int

A altura da janela, em pixels.

wMax

Tipo: int

Opções para exibição da janela. Qualquer um dos valores que podem ser especificados no parâmetro nCmdShow para a função ShowWindow.

rgchMember[2]

Tipo: TCHAR[2]

O nome da janela.

Comentários

A Ajuda do Windows divide a tela em 1024 unidades nas direções X e Y. Para criar uma janela secundária que preencha o quadrante superior esquerdo da exibição, por exemplo, um aplicativo especificaria zero para os membros x e y e 512 para os membros dx e dy .

Para calcular wStructSize corretamente, o tamanho real da cadeia de caracteres a ser armazenada em rgchMember deve ser conhecido. Como sizeof(HELPWININFO) inclui dois TCHARs por definição, eles devem ser levados em conta no total final. O exemplo a seguir mostra o cálculo adequado de uma instância 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;
}

Observação

O cabeçalho winuser.h define HELPWININFO como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho	winuser.h