Page 1 of 1

how to get description of the API function under the cursor

Posted: Mon Feb 13, 2006 11:21 pm
by DoMi
in jaPBe we got description of the API function (status bar) under the cursor and using F1 Win32 help file is opened at the right location of the function description
I'd like to go back to the original PB editor
In the config tool... I can't manage to open API help file at the right page using %WORD as parameter !?
Is there a way to do that in the original PB editor?

thanks for a link to this (old?) topic

Posted: Tue Feb 14, 2006 12:05 am
by fsw
Create a directory with the name HELP inside your PUREBASIC directory.
Copy WIN32.HLP to PUREBASIC\HELP.
Open source code and move cursor to API call.
Press F1 - the win32 help should show up.

This issue is history related.
In the early days PureBasic's help files have been a chunk of html files that resided in PUREBASIC\HELP.
Some point in time a CHM file was generated and resided in PUREBASIC.
The HTML files went obsolete - and with it the PUREBASIC\HELP dir.


Maybe this issue should be added to the docs.

Posted: Tue Feb 14, 2006 12:05 am
by Kale
Place the Win32 help file in the dir: Purebasic/help, then hit f1 in the editor and thats it.

Posted: Tue Feb 14, 2006 12:06 am
by fsw
faster :mrgreen:

Posted: Tue Feb 14, 2006 12:07 am
by Kale
to go online during F1 to see the command description, see this:

viewtopic.php?t=19269

Posted: Tue Feb 14, 2006 12:07 am
by Kale
fsw wrote:faster :mrgreen:
lol :lol:

Posted: Tue Feb 14, 2006 12:27 am
by freak
> Maybe this issue should be added to the docs.

Its allready described in the docs.. one just has to read it ;)

All solution tested and effective...

Posted: Tue Feb 14, 2006 12:36 am
by DoMi
thanks for your help
The solutions work all fine
It seems arguments are given in statusbar for only few API functions
e.g. :for GetFileType_(hFile) it's OK
but for SetWindowLong_() : "no Quick-help available"
Is there an editable API functions header file in PB that I can complete ?

thanks

Posted: Tue Feb 14, 2006 12:45 am
by fsw
The help says:
  • To use it from the PureBasic IDE, just copy the "win32.hlp" file into the Help subdirectory of your purebasic folder.
But there is no HELP subdirectory in the purebasic folder (well not anymore...).

Change text to (or similar):
  • To use it from the PureBasic IDE, just copy the "win32.hlp" file into the Help subdirectory of your purebasic folder.
    If there is no Help subdirectory create one and proceed as described above.
@Freak
[english] Sorry [/english]
[german] manchmal bin ich ein richtiger [/german]
[alemannisch] tuepflischisser [/alemannisch]
:lol:

Posted: Tue Feb 14, 2006 10:20 am
by blueznl
freak wrote: > Maybe this issue should be added to the docs.

Its allready described in the docs.. one just has to read it ;)
oh really?

http://www.xs4all.nl/~bluez/datatalk/pure1.htm#set_up

Posted: Fri Feb 17, 2006 3:11 am
by netmaestro
Win32.hlp is ok but limited. The platform sdk method is more complete and quite a bit faster than looking the topic up on the internet.

Posted: Fri Feb 17, 2006 5:11 am
by PB
> Win32.hlp is ok but limited

Here's the pros and cons of each:

Win32.hlp = Small install, limited info, can be used offline, but is way out of date.
MS SDK = Large install, lots of info, can be used offline, but won't stay up to date.
MSDN Site = No install, lots of info, can't be used offline, but is always up to date.

So take yer pick. :)