PureBasic Docs - Errors & needed improvements to the man

[Trond]

GetClipboardImage() mentions obsolete constant #PB_Image_DisplayFormat.

[Demivec]

None of the commands in the LinkedList library (i.e. AddElement(), SwapElements(), etc.) are brought up when pressing F1 in the IDE.

The help file displays "This program cannot display the webpage" instead.

The help file does contain the information, it just isn't available using F1 from the IDE so I might need to post this in the Bug section instead. Please let me know.

[HwyStar]

SortStructuredList() and SortList() do not appear in the main "PureBasic - LinkedList" section.

[luis]

PB 4.50

Help on DESFingerprint()

"compatiable which any standard linux hash password " should be "compatible with ..."

Now it's " compatible which " ... almost there !

in 4.40 B7
in the PureBasic - Map (overview) the link to the sample program Map.pb doesn't work, at least on my system...

Now the link to the sample program it's vanished altogether

AddMapElement()

Note: This function isn't mandatory when dealing with maps, as elements are automatically added when affecting a value to them

Affecting ? Maybe should be "assigning" ? Or "storing a value into them" ?

Still there.

Maps - Overview

You can add as many elements as you want (or as many as will fit into the memory of your computer), and accessing it back using a key.

Maybe "access them back" ?

Still there.

- Typing ArraySize() and pressing F1 leads to the wrong manual page (Array instead of ArraySize()).

Just found this me too, still present in 4.50 final

[luis]

PB4.50

Structures

"ClearStructure can be used to clear a structured memory area. It's for advanced use only, when pointers are involved."

probably would be better this way:

"ClearStructure can be used to clear a structured memory area. It's for advanced use only, when dynamically allocated structures are involved and it's not intended to be used on a normal structured variable."

see this thread for more info: http://www.purebasic.fr/english/viewtop ... 13&t=41702

and the relative example under

Compiler Functions

The ClearStructure() example should probably use ClearStructure() on a dynamically allocated structure.

something like this:

Code: Select all

Structure People
    Name$
    LastName$
    Age.l
EndStructure

*Student.People = AllocateMemory(SizeOf(People))

*Student\Name$ = "Paul"
*Student\LastName$ = "Morito"
*Student\Age = 10
  
ClearStructure(*Student, People) ; this is needed to release the strings
  
; Will print empty strings as the whole structure has been cleared. All other fields have been resetted to zero.

Debug *Student\Name$
Debug *Student\LastName$
Debug *Student\Age

FreeMemory(*Student) ; now is safe to release the memory

instead of the current

Code: Select all

  Structure People
    Name$
    LastName$
    Age.l
  EndStructure

  Student.People\Name$ = "Paul"
  Student\LastName$ = "Morito"
  Student\Age = 10
  
  ClearStructure(@Student, People)
  
  ; Will print empty strings as the whole structure has been cleared. All other fields have been resetted to zero.
  ;
  Debug Student\Name$
  Debug Student\LastName$
  Debug Student\Age

[Demivec]

The manual's explanation for the Bitwise Not operator '~' includes the example code:

Code: Select all

; Shown using binary numbers as it will be easier to see the result
a.w = ~%1000 ; Result will be %0111
b.w = ~%1010 ; Result will be %0101

The commented results are wrong. They will be %1111111111110111 for a.w and %1111111111110101 for b.w .

Clearer demonstration code should be provide or the comments corrected.

[Vera]

None of the commands in the LinkedList library (i.e. AddElement(), SwapElements(), etc.) are brought up when pressing F1 in the IDE.
The help file displays "This program cannot display the webpage" instead.
The help file does contain the information, it just isn't available using F1 from the IDE so I might need to post this in the Bug section instead. Please let me know.

I've cross-checked the helps with PB 4.41. The current help popsup correct with the former version and the old help neither with PB 4.50 so it should be a bug within the IDE.
If that's evident enough to report, please do so.

greetings ~ Vera

[Demivec]

None of the commands in the LinkedList library (i.e. AddElement(), SwapElements(), etc.) are brought up when pressing F1 in the IDE.
The help file displays "This program cannot display the webpage" instead.
The help file does contain the information, it just isn't available using F1 from the IDE so I might need to post this in the Bug section instead. Please let me know.

I've cross-checked the helps with PB 4.41. The current help popsup correct with the former version and the old help neither with PB 4.50 so it should be a bug within the IDE.
If that's evident enough to report, please do so.

@Vera: Thankyou for your response I've reported it in thread http://www.purebasic.fr/english/viewtopic.php?f=4&t=42616

[HwyStar]

The help text is lacking when it talks about "CatchImage", "DataSections" and "IncludeBinary"...

Modify the "CatchImage" help text code with something like this to help us understand several concepts that the above commands support:

Code: Select all

If OpenWindow(0, 0, 0, 500, 400, "Embed Icon", #PB_Window_SystemMenu | #PB_Window_ScreenCentered)
  TrayIcon = CatchImage(1, ?Icon)
  Tray = AddSysTrayIcon(2, WindowID(0), TrayIcon)
  SysTrayIconToolTip(2, "Embedded Icon Example")

  Quit = #False
  Repeat
    Event = WaitWindowEvent()
    Select event
    Case #PB_Event_CloseWindow
      RemoveSysTrayIcon(2)
      Quit = #True
    EndSelect
  Until Quit = #True
  CloseWindow(0)
EndIf

;Embed Tray Icon into exe using DataSection
DataSection
Icon: 
  IncludeBinary "c:\Images\MyIcon.ico" ;Change This!
EndDataSection 

[Foz]

Windows 4.50: Pressing F1 on ChangeCurrentElement results in "This program cannot display the webpage" in the Help window.

Clicking through from the reference library works just fine.

*** edit: SelectElement does the same as well.

[jamirokwai]

Hi Andre,

in the English manual: The text #PB_Date_CheckBox in the 3rd paragraph of Description should be red.
Would be great to have plateform-dependant information in bold fonttype - e.g. DateGadget #PB_Date_UpDown only supported on Windows.

[Comtois]

Mod() is not in the doc

[Vera]

moved posting

Just found one (small) problem, but maybe some more could be added to this thread

PB4.50 German
• Page "Anpassen der IDE": pictures missing below "Editor - Einrückung" and "Compiler"

[PB]

The manual for MovieStatus() says:

Note: Be careful with this function when using sounds (e.g. MP3) as no pictures (frames) exist.

This warning now seems to be obsolete, because MovieStatus() works
for MP3s and returns 0 when the MP3 has finished playing. See here:

http://www.purebasic.fr/english/viewtop ... 13&t=32020

[Vera]

Font.pb - example is 'corrupt'

since PB 4.41 the DrawText doesn't show anymore because for StartDrawing() the front color has been set to white and transparent mode is turned on.

So a white background color parameter for the BOX is obsolete (except to overwrite the default black background of all objects)

Now - any object is white => the box-area is white , => the text is white while his background is removed

Quickest solution : remove the transparent mode or (nicer) change the box color

greetings ~ Vera