pfc_help


pfcmain.pbl   >   pfc_w_master   >   pfc_help   

Full name pfc_w_master.pfc_help
Access public
Extend of integer
Return value integer
Prototype event integer pfc_help()

Name Datatype
No Data

Name Datatype
ll_helptypeid Long
ls_helpfile String
ls_helptypeid String

event pfc_help;//////////////////////////////////////////////////////////////////////////////
//
//	Event:  pfc_help
//
//	Arguments:  none
//
//	Returns:  integer
//	 1 = success
//	 0 = helpfile property of the application manager not specified
//	-1 = error
//
//	Description:
//	Call the windows help file associated with the application.
//	Uses the HelpType property of this window to determine what help
//	to display.
//
//////////////////////////////////////////////////////////////////////////////
//	
//	Revision History
//
//	Version
//	5.0   Initial version
// 7.0 	If help type id is not specified open the top-level contents topic.
//
//////////////////////////////////////////////////////////////////////////////
//
//	Copyright © 1996-1997 Sybase, Inc. and its subsidiaries.  All rights reserved.
//	Any distribution of the PowerBuilder Foundation Classes (PFC)
//	source code by other than Sybase, Inc. and its subsidiaries is prohibited.
//
//////////////////////////////////////////////////////////////////////////////

Long		ll_helptypeid
String	ls_helpfile
String	ls_helptypeid

ls_helpfile = gnv_app.of_GetHelpFile()
If Len (Trim (ls_helpfile)) > 0 Then
	If Lower (ClassName (ia_helptypeid)) = 'long' Then
		ll_helptypeid = ia_helptypeid
		Return ShowHelp (ls_helpfile, Topic! , ll_helptypeid)
	ElseIf Lower (ClassName (ia_helptypeid)) = 'string' Then
		ls_helptypeid = ia_helptypeid
		Return ShowHelp (ls_helpfile, Keyword!, ls_helptypeid)
	Else
		Return ShowHelp (ls_helpfile, Index!)
	End If
End If

If IsValid(gnv_app.inv_debug) Then		
	of_MessageBox ("pfc_master_helpdebug", "PowerBuilder Class Library", "Help has been requested but the"+&
					" Required Help File Name has Not been Set.  Use of_SetHelpFile"+&
					" on The Application Manager to Set The attribute.", &
					Exclamation!, OK!, 1)
End If
				
Return 0
end event

     
Name Owner
No Data

     
Name Owner
systemfunctions.classname systemfunctions
systemfunctions.isvalid systemfunctions
systemfunctions.len systemfunctions
systemfunctions.lower systemfunctions
systemfunctions.showhelp systemfunctions
systemfunctions.showhelp systemfunctions
systemfunctions.showhelp systemfunctions
systemfunctions.trim systemfunctions
pfc_n_cst_appmanager.of_gethelpfile pfc_n_cst_appmanager
pfc_w_master.of_messagebox pfc_w_master

     
Full name
demopfc

     
Name Scope
No Data