Click above to get retro games delivered to your door ever month!

Function:    RH_HEADER()

Purpose:     Retrieve the header from a RHELP compiled help file

Syntax:      RH_HEADER( rhelpFile )

Arguments:   rhelpFile   - This parameter may be either the rhelp compiled
                           filename, or the numeric file handle returned
                           from a previous call to FOPEN() to open the
                           help file.

Returns:     The header from the specified help file.

Description: This function reads and returns the header from a help file
             that was compiled with the Rhelp compiler.  This header has a
             specific structure, but you need not concern yourself with
             the details of this structure unless you want to access the
             header record elements directly.  All header and header
             record information is available through calls to the various
             Rhelp functions (API).

             See Appendix C entitled The RHELP Compiler for more detailed
             information and examples.

Notes:       If the helpfile parameter is supplied as a character string,
             it is deemed to be the name of the Rhelp file.  In this case
             the help file is opened (using FOPEN()), the header is then
             extracted, the help file closed, and the header returned.  If
             the FOPEN() fails, a null is returned, and RLIBERROR() set.

             If the helpfile parameter is supplied as a numeric value, it
             is deemed to be the numeric file handle returned by
             previously FOPEN()ing the help file.  In this case, the
             header is read and returned, but the file is not closed.
             This feature allows you the flexibility of leaving the help
             file open during the course of your application, therefore
             speeding up access by not having to constantly open and close
             the help file.  This method of access is not recommended if
             you are short on file handles or you are not comfortable with
             low level file operations.  If you use this method, always
             remember to FCLOSE() your files.

             You should not need to explicitly extract the header since
             all help functions are available.  However, the header may be
             manipulated directly for speed considerations.  Also, the
             other help functions use this function to extract the header.

Example:     helpHeader = RH_HEADER("myapp.hlp")

             *-- or

             helpHandle = FOPEN("myapp.hlp")
             helpHeader = RH_HEADER( helpHandle )

Source:      RL_RHELP.PRG

See also:    RH_TEXT(), RH_WIDTH(), RH_LINES()