WinHelp_GetHelpType()

Examples


The WinHelp_GetHelpType() function returns an integer indicating the type of help the user requested.

Syntax

WinHelp_GetHelpType()

Parameters

• None

Return value

An integer corresponding to one the following constants.

[spacer]

Constant

Help type

HELP_TYPE_CONTENTS

Display help contents

HELP_TYPE_SEARCH

Search

HELP_TYPE_HELP_KEY

Help key processing (F1 key)

HELP_TYPE_WHATS_THIS_WIN

Window-level help

HELP_TYPE_WHATS_THIS_FIELD

Field-level help

HELP_TYPE_WHATS_THIS_MODE

“What's this?” mode

HELP_TYPE_DIALOG_HELP

Modal dialog help


Comments

This function is typically used in the help processing procedure script to find out the type of help the user requested.


Documentation Feedback