IfmManage::fmStartHelp

This method causes the application to enter the help display mode.

Syntax

HRESULT fmStartHelp( BSTR bstrFileName, DWORD dwFlags, DWORDdwTopicID );

Parameters

bstrFileName

Unicode string that contains the name of the Help text file. If dwFlags is not APCHELP_INDEX, bstrFieldName can be 0.

dwFlags

Specifies one of the following flags:

APCHELP_INDEX

Shows the Help index.

APCHELP_TOPIC

Shows a Help topic.

dwTopicID

Specifies the topic file name if dwFlags is APCHELP_TOPIC. Otherwise, it is set to 0.

Return Values

NOERROR indicates success. If an error occurs, the appropriate HRESULT value is returned.

Remarks

When this method is called, it hides the form’s option menu.

See Also

IfmManage::fmStopHelp