Jump to content
Sign in to follow this  
SteveJM

How to report error in documentation (DllStructCreate)

Recommended Posts

SteveJM

One of the (many) great things about Autoit is that the documentation is really pretty good. However in trying to answer the question of a friend I have found that the documentation on the function DllStructCreate() has significant and easily fixed flaws. Trying to be public spirited, do I report that as a bug, or is there a separate place to report it. I have tried making a search of the FAQ and forums but have not yet found any reference.

The issue that brought this up: The types that can be declared in DllStructCreate().

Older code of mine, written when I was using 3.2.10.0, makes use of the types byte and ubyte, described in the help files then as signed and unsigned char. The new help file (checked on-line and in 3.3.6.1) now describes BYTE as unsigned. There is now a mixture of lower and upper case types described, but no explicit mention is made that they are case sensitive. Are they? Has BYTE really changed, a potential scrip breaking change that hasn't been mentioned in the History file. Is ubyte still available. It is still used in the example on the help page that doesn't include it as a possibility.

This is not a complaint! I just thought it might help others to get the documentation fixed. Thanks for any clarification

Share this post


Link to post
Share on other sites
SteveJM

The bug tracker is here. Thanks :mellow:

Thanks - yes I'd found that, but I had assumed that it was for bugs/crashes in the code rather than improvements to the documentation. Is it truly the right place for a documentation issue?

Share this post


Link to post
Share on other sites
Melba23

SteveJM,

Is it truly the right place for a documentation issue?

Absolutely. :P

When you create a ticket, you need to select a "Component" and "Documentation" is listed there. :mellow:

M23


Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind._______My UDFs:

Spoiler

ArrayMultiColSort ---- Sort arrays on multiple columns
ChooseFileFolder ---- Single and multiple selections from specified path treeview listing
Date_Time_Convert -- Easily convert date/time formats, including the language used
ExtMsgBox --------- A highly customisable replacement for MsgBox
GUIExtender -------- Extend and retract multiple sections within a GUI
GUIFrame ---------- Subdivide GUIs into many adjustable frames
GUIListViewEx ------- Insert, delete, move, drag, sort, edit and colour ListView items
GUITreeViewEx ------ Check/clear parent and child checkboxes in a TreeView
Marquee ----------- Scrolling tickertape GUIs
NoFocusLines ------- Remove the dotted focus lines from buttons, sliders, radios and checkboxes
Notify ------------- Small notifications on the edge of the display
Scrollbars ----------Automatically sized scrollbars with a single command
StringSize ---------- Automatically size controls to fit text
Toast -------------- Small GUIs which pop out of the notification area

 

Share this post


Link to post
Share on other sites
ProgAndy

Just for information: byte has always been unsigned, so ubyte is useless and the documentation was not correct.

DLLStructCreate is still case-insensitive, so it is not important whether you use uppercase or lowercase.

Edited by ProgAndy

*GERMAN* [note: you are not allowed to remove author / modified info from my UDFs]My UDFs:[_SetImageBinaryToCtrl] [_TaskDialog] [AutoItObject] [Animated GIF (GDI+)] [ClipPut for Image] [FreeImage] [GDI32 UDFs] [GDIPlus Progressbar] [Hotkey-Selector] [Multiline Inputbox] [MySQL without ODBC] [RichEdit UDFs] [SpeechAPI Example] [WinHTTP]UDFs included in AutoIt: FTP_Ex (as FTPEx), _WinAPI_SetLayeredWindowAttributes

Share this post


Link to post
Share on other sites
SteveJM

Many thanks - I consider myself well and truly answered (and astonishingly fast too). I'll try and find the time to mention the confusing sample code in the documentation using the ticket system.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
Sign in to follow this  

×