HELPWININFOA 構造体 (winuser.h)

プライマリ ヘルプ ウィンドウまたはセカンダリ ヘルプ ウィンドウのサイズと位置を格納します。 アプリケーションでは、HELP_SETWINPOS値を使用して WinHelp 関数を呼び出すことで、この情報を設定できます。

構文

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

メンバー

wStructSize

型: int

この構造体のサイズ (バイト単位)。

x

型: int

ウィンドウの左上隅の X 座標 (画面座標)。

y

型: int

ウィンドウの左上隅の Y 座標 (画面座標)。

dx

型: int

ウィンドウの幅 (ピクセル単位)。

dy

型: int

ウィンドウの高さ (ピクセル単位)。

wMax

型: int

ウィンドウの表示オプション。 ShowWindow 関数の nCmdShow パラメーターで指定できる任意の値を指定できます。

rgchMember[2]

種類: TCHAR[2]

ウィンドウの名前。

注釈

Windows ヘルプでは、ディスプレイが X 方向と Y 方向の両方で 1024 単位に分割されます。 たとえば、ディスプレイの左上のクアドラントを塗りつぶすセカンダリ ウィンドウを作成するには、アプリケーションで x メンバーと y メンバーに 0、 dx メンバーと dy メンバーに 512 を指定します。

wStructSize を正しく計算するには、rgchMember に格納される文字列の実際のサイズがわかっている必要があります。 sizeof(HELPWININFO) には定義上 2 つの TCHAR が含まれるため、最終的な合計で考慮する必要があります。 次の例は、 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;
}

注意

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして HELPWININFO を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
Header	winuser.h