HH_WINTYPE structure

Use this structure to specify or modify the attributes of a window type.

Window types can be defined by an author in a project (.hhp) file, or they can be defined programmatically using the HTML Help API.

When a HH_WINTYPE structure is passed to HtmlHelp() using the HH_SET_WIN_TYPE command, the HTML Help API makes a private copy of the contents of the structure. The help developer is therefore responsible for freeing memory used by the HH_WINTYPE structure or character arrays within it. The help developer can free memory after calling HH_SET_WIN_TYPE.

Used by

HH_WINTYPE structure syntax


typedef struct tagHH_WINTYPE

{

     int           cbStruct;        

     BOOL          fUniCodeStrings; 

     LPCTSTR       pszType;         

     DWORD         fsValidMembers;  

     DWORD         fsWinProperties; 

     LPCTSTR       pszCaption;     

     DWORD         dwStyles;       

     DWORD         dwExStyles;     

     RECT          rcWindowPos;    

     int           nShowState;     

     HWND          hwndHelp;     

     HWND          hwndCaller;

     HWND          hwndToolBar;      

     HWND          hwndNavigation;   

     HWND          hwndHTML;         

     int           iNavWidth;        

     RECT          rcHTML;           

     LPCTSTR       pszToc;     

     LPCTSTR       pszIndex;   

     LPCTSTR       pszFile;    

     LPCTSTR       pszHome;    

     DWORD         fsToolBarFlags; 

     BOOL          fNotExpanded; 

     int           curNavType; 

     int           idNotify; 

     LPCTSTR       pszJump1;

     LPCTSTR       pszJump2;

     LPCTSTR       pszUrlJump1;

     LPCTSTR       pszUrlJump2;  

} HH_WINTYPE;

Member	Description
cbStruct	Specifies the size of the structure. This value must always be filled in before passing the structure to HtmlHelp().
fUniCodeStrings	Specifies whether the strings used in this structure are UNICODE.
pszType	A null-terminated string that specifies the name of the window type.
fsValidMembers	Specifies which members in the structure are valid.
fsWinProperties	Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.
pszCaption	A null-terminated string that specifies the caption to display in the title bar of the window.
dwStyles	Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the fsValidMembers and fsWinProperties parameters.
dwExStyles	Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the fsValidMembers and fsWinProperties parameters.
rcWindowPos	Specifies the coordinates of the window in pixels. The values are read in the following order: `rcWindowPos = {left, top, right, bottom};`
nShowState	Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.
hwndHelp	Specifies the handle of the window if the window has been created.
hwndCaller	Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.
idNotify	Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.

Members specific to the Help Viewer

Member	Description
hwndToolBar	Specifies the handle of the toolbar.
hwndNavigation	Specifies the handle of the Navigation pane.
hwndHTML	Specifies the handle of the Topic pane, which hosts Shdocvw.dll.
iNavWidth	Specifies the width of the Navigation pane when the Help Viewer is expanded.
rcHTML	Specifies the coordinates of the Topic pane.
pszToc	Specifies the contents (.hhc) file to display in the Navigation pane.
pszIndex	Specifies the index (.hhk) file to display in the Navigation pane.
pszFile	Specifies the default HTML file to display in the Topic pane.
pszHome	Specifies the file or URL to display in the Topic pane when the Home button is clicked.
fsToolBarFlags	Specifies which buttons to include on the toolbar.
fNotExpanded	Specifies that the Help Viewer open with the Navigation pane closed.
curNavType	Specifies the default tab to display on the Navigation pane.
pszJump1	Specifies the text to display underneath the Jump1 button.
pszJump2	Specifies the text to display underneath the Jump2 button.
pszUrlJump1	Specifies the URL to jump to when the Jump1 button is clicked.
pszUrlJump2	Specifies the URL to jump to when the Jump2 button is clicked.

HH_WINTYPE structure

Used by

HH_WINTYPE structure syntax

Members specific to the Help Viewer

See Also