PDA

View Full Version : Help_File, Dictionary-Equates documented wrongly



ReneMiner
04-05-2015, 08:50
Help documents
ThinBASIC-Modules> Dictionary> Dictionary-Equates
and also
ThinBASIC-Modules> Dictionary> cDictionary-Class> Dictionary-Equates

wrong:

%HT_MemInfo_Total
%HT_MemInfo_Keys
%HT_MemInfo_Data

probably should be

%DICTIONARY_MEMINFO_TOTAL
%DICTIONARY_MEMINFO_KEYS
%DICTIONARY_MEMINFO_DATA


________________________________________________________

also to dictionary-module,
>Dictionary_Exists
Current Remark is wrong, it says:

"To retrieve length of stored data use StrPtrLen function passing pointer returned by Dictionary_Exists"

This is wrong because the function returns the position where to read out the StrPtr, but it's not the StrPtr itself!
Using this the way it's described in help leads to crash.
It should say:

To retrieve length of stored data use StrPtrLen function passing a DWord At pointer returned by Dictionary_Exists.

It's the programmers responsibility to make sure by Dictionary_Exists returned pointer is valid before accessing memory. (not zero)

Example:


Dim pData As DWord At Dictionary_Exists(pDictionary, KeyName)

If GetAt(pData) <> 0 Then
SizeOfData = StrPtrLen(pData)
EndIf