how to get description of the API function under the cursor

Working on new editor enhancements?
DoMi
User
User
Posts: 67
Joined: Sat Jan 10, 2004 5:41 pm
Location: France

how to get description of the API function under the cursor

Post 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
DoMi
User avatar
fsw
Addict
Addict
Posts: 1603
Joined: Tue Apr 29, 2003 9:18 pm
Location: North by Northwest

Post 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.
Kale
PureBasic Expert
PureBasic Expert
Posts: 3000
Joined: Fri Apr 25, 2003 6:03 pm
Location: Lincoln, UK
Contact:

Post by Kale »

Place the Win32 help file in the dir: Purebasic/help, then hit f1 in the editor and thats it.
--Kale

Image
User avatar
fsw
Addict
Addict
Posts: 1603
Joined: Tue Apr 29, 2003 9:18 pm
Location: North by Northwest

Post by fsw »

faster :mrgreen:
Kale
PureBasic Expert
PureBasic Expert
Posts: 3000
Joined: Fri Apr 25, 2003 6:03 pm
Location: Lincoln, UK
Contact:

Post by Kale »

to go online during F1 to see the command description, see this:

viewtopic.php?t=19269
--Kale

Image
Kale
PureBasic Expert
PureBasic Expert
Posts: 3000
Joined: Fri Apr 25, 2003 6:03 pm
Location: Lincoln, UK
Contact:

Post by Kale »

fsw wrote:faster :mrgreen:
lol :lol:
--Kale

Image
freak
PureBasic Team
PureBasic Team
Posts: 5940
Joined: Fri Apr 25, 2003 5:21 pm
Location: Germany

Post by freak »

> Maybe this issue should be added to the docs.

Its allready described in the docs.. one just has to read it ;)
quidquid Latine dictum sit altum videtur
DoMi
User
User
Posts: 67
Joined: Sat Jan 10, 2004 5:41 pm
Location: France

All solution tested and effective...

Post 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
DoMi
User avatar
fsw
Addict
Addict
Posts: 1603
Joined: Tue Apr 29, 2003 9:18 pm
Location: North by Northwest

Post 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:
User avatar
blueznl
PureBasic Expert
PureBasic Expert
Posts: 6166
Joined: Sat May 17, 2003 11:31 am
Contact:

Post 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
( PB6.00 LTS Win11 x64 Asrock AB350 Pro4 Ryzen 5 3600 32GB GTX1060 6GB)
( The path to enlightenment and the PureBasic Survival Guide right here... )
User avatar
netmaestro
PureBasic Bullfrog
PureBasic Bullfrog
Posts: 8451
Joined: Wed Jul 06, 2005 5:42 am
Location: Fort Nelson, BC, Canada

Post 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.
Last edited by netmaestro on Tue Feb 21, 2006 12:55 pm, edited 3 times in total.
PB
PureBasic Expert
PureBasic Expert
Posts: 7581
Joined: Fri Apr 25, 2003 5:24 pm

Post 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. :)
I compile using 5.31 (x86) on Win 7 Ultimate (64-bit).
"PureBasic won't be object oriented, period" - Fred.
Post Reply