


DXmHelpSystemOpen(3X)					DXmHelpSystemOpen(3X)



NAME
  DDXXmmHHeellppSSyysstteemmOOppeenn - Completes	initialization operations required by Link-
  Works	and prepares to	display	a topic	from the specified help	file name.

SYNOPSIS

  vvooiidd DDXXmmHHeellppSSyysstteemmOOppeenn((_h_e_l_p__c_o_n_t_e_x_t,, _m_a_i_n__w_i_n_d_o_w,, _h_e_l_p__f_i_l_e,, _r_o_u_t_i_n_e,,	_t_a_g))
	OOppaaqquuee	**_h_e_l_p__c_o_n_t_e_x_t;;
	WWiiddggeett	_m_a_i_n__w_i_n_d_o_w;;
	cchhaarr	**_h_e_l_p__f_i_l_e;;
	vvooiidd	((((**_r_o_u_t_i_n_e ))(()))),,
	OOppaaqquuee	_t_a_g));;

PARAMETERS

  _h_e_l_p__c_o_n_t_e_x_t
      Used by the DECwindows Motif Help	System to pass required	LinkWorks and
      help information from one	routine	to another.  Note that _h_e_l_p__c_o_n_t_e_x_t
      must be defined globally;	the DDXXmmHHeellppSSyysstteemmDDiissppllaayy and DDXXmmHHeellppSSyysstteemm--
      CClloossee routines subsequently use the address initially set	for this
      parameter.

  _m_a_i_n__w_i_n_d_o_w
      The identifier (ID) for the main window of the application.

  _h_e_l_p__f_i_l_e
      The file name of the help	file.  The default specifications are as fol-
      lows:


      _______________________________________

      Default		   Description

      _______________________________________

      /usr/lib/X11/help/   Directory location

      .decw_book	   File	extension

      _______________________________________

      You can also provide your	own location or	extension along	with the help
      file name.

      Note that	_h_e_l_p__f_i_l_e is required for this routine but is optional for
      DDXXmmHHeellppSSyysstteemmDDiissppllaayy.

  _r_o_u_t_i_n_e
      Used for error processing.  If an	error occurs within the	DECwindows
      Motif Help System	and it cannot be processed by either LinkWorks or
      Bookreader, the DECwindows Motif Help System calls the error processing
      routine you have included	in your	application and	passes in an integer,
      or _s_t_a_t_u_s, to indicate the status	of the error processing	operation, as
      follows:


      __________________________________

      Value   Description

      __________________________________

      1

	      The DECwindows Motif Help
	      System could not find the
	      LinkWorks	shareable image.

      2

	      The DECwindows Motif Help
	      System could not translate
	      a	specified value	into a
	      valid file specification.

      __________________________________

      Note the following:

	oo++
	The _s_t_a_t_u_s parameter is	a _s_y_s_t_e_m-_s_u_p_p_l_i_e_d parameter that supplements
	the _r_o_u_t_i_n_e and	_t_a_g parameters you have	already	specified in the
	application.

	oo++
	If an error cannot be processed	by either LinkWorks or Bookreader and
	you have not specified a supplementary error handling routine, your
	system will generate an	access violation error message.

  _t_a_g The parameter you	supply to the previously described _r_o_u_t_i_n_e parameter.
      Associating a tag	with the routine enables you to	more easily determine
      where errors occur.

DESCRIPTION

				     NNOOTTEE
       This routine is not supported on	all operating systems.

  Within the DECwindows	Motif Help System, the DDXXmmHHeellppSSyysstteemmOOppeenn routine com-
  pletes all of	the initialization operations required by LinkWorks, such as
  creating a DECwindows	user interface object and a surrogate object, and
  then prepares	to display a topic from	the help file name passed in.  You
  should make the call to this routine just before the main loop of your
  application.

RELATED	INFORMATION

  DDXXmmHHeellppSSyysstteemmCClloossee(3X), DDXXmmHHeellppSSyysstteemmDDiissppllaayy(3X)




















