. DirectXtras Home
        Home

DirectCommunication Xtra
DirectConnection Xtra
DirectControl Xtra
DirectEmail Xtra
DirectFTP Xtra
DirectImage Xtra
DirectInteraction Xtra
DirectOS Xtra
Documentation
License Agreement
Licensing Fees
Order Form
DirectSMS Xtra
DirectSound Xtra
DirectTransition Xtra
DirectTransition3D Xtra Set I
DirectTransition3D Xtra Set II
DirectTransition3D Xtra Set III
DirectTTS Xtra
XtrAgent
DirectXport Xtra

SpeechPlugin

Special Discounted Bundles

The Gallery
How To Order
Order Form
Check for Upgrades

Sign in
Change Your Profile

Contact Us
















    .
DirectXtras
Xtra Power for Director & Authorware



DirectOS Xtra
 Directing Windows and MacOS. The OS at your fingertips!

Authorware 4.x Compatible Authorware 5.x CompatibleAuthorware 6.x CompatibleAuthorware 7.x CompatibleDirector 5.x Compatible Director 6.x CompatibleDirector 7.x Compatible Director 8.x CompatibleDirector MX Compatible     Windows Compatible   

dosWinHelp(string FileName, string Command, string Info)

Opens the specified help file. The function starts Microsoft Windows Help (Winhelp.exe) and passes additional data that indicates the nature of the help requested by the application.

Parameters :

FileName : A string specifying the pathname to a windows help file. Windows help files have an extension of ".hlp". Note that error checking is not done to determine if FileName is a valid .hlp file. The file name can be followed by an angle bracket (>) and the name of a secondary window if the topic is to be displayed in a secondary window rather than in the primary window. You must define the name of the secondary window in the [WINDOWS] section of the Help project (.hpj) file.

Command : A case insensitive string specifying what to display in the windows help file.
Possible Values :
"Contents" :
Displays the topic specified by the Contents option in the [OPTIONS] section of the .hpj file. Info is ignored with this flag.
"Topics" : Displays the Help Topics dialog box. Info is ignored with this flag.
"Keyword" : Displays the topic in the keyword table that matches the keyword specified by Info, if there is an exact match. If there is more than one match, displays the Index with the topics listed in the Topics Found list box. Info must be a valid string specifying the keyword. If there is a subtopic that is of interest, within a particular keyword, simply separate the two with a comma and no spaces. For example "theTopic,theSubTopic". Multiple keywords must be separated by semicolons. To display the index without passing a keyword, pass in an empty string for Info.
"Partial keyword" : Displays the topic in the keyword table that matches the keyword specified by Info, if there is an exact match. If there is more than one match, displays the Topics Found dialog box. Info must be a valid string specifying the keyword. If there is a subtopic that is of interest, within a particular keyword, simply separate the two with a comma and no spaces. For example "theTopic,theSubTopic". Multiple keywords must be separated by semicolons. To display the index without passing a keyword, pass in an empty string for Info.
"Macro" :
Executes a Help macro or macro string specified by Info. Info must be a valid string that specifies the name(s) of the Help macro(s) to run. If the string specifies multiple macro names, the names must be separated by semicolons. You must use the short form of the macro name for some macros because Windows Help does not support the long name.
"Popup" : Displays the topic identified by the specified context identifier defined in the [MAP] section of the .hpj file in a pop-up window. Info must be a valid string specifying the context identifier.
"Context" : Displays the topic identified by the specified context identifier defined in the [MAP] section of the .hpj file. Info must be a valid string specifying the context identifier.
"Quit" : Informs Windows Help that it is no longer needed. If no other applications have asked for help, Windows closes Windows Help. Info is ignored with this flag.
"Help" : Displays the Help on using Windows Help file.  Info is ignored with this flag.


Info : A string specifying additional data. The value used depends on the value of the Command and may be ignored by some commands.

Return Value : An integer indicating whether the method succeeded or failed. A value of 1 indicates that the method succeeded. A value of 0 indicates the method failed, in which case dosGetLastError() should be called to determine the cause of the error.

Possible Returned Error Codes :
10002 :
Invalid value for parameter 2.
10014 : File name expected. Reference to a drive or folder was given.
10016 : File name specified by FileName was not found.
10022 : Method is not supported on MacOS.



DirectXtras Inc.
P.O Box 2645, Menlo Park, CA, 94026, U.S.A
Voice: +1-415-5058249, Fax: +1-801-8585841
Toll Free: 1-800-4453093
E-mail General Information: info@directxtras.com
E-mail Technical Support: support@directxtras.com

Copyright 1996-2004 DirectXtras Inc. All Rights Reserved.
WebMaster: tamar@directxtras.com
Last Updated: 12/20/2002 4:56:46 AM.