Opened 7 years ago
Closed 4 years ago
#3579 closed Feature Request (Fixed)
Clarification of Help for DllStructGetData(): never returns an array
Reported by: | c.haslam | Owned by: | Jpm |
---|---|---|---|
Milestone: | 3.3.15.4 | Component: | Documentation |
Version: | Severity: | None | |
Keywords: | Cc: |
Description
jchd has invited me to take a crack at improving the help for this function: see https://www.autoitscript.com/forum/topic/191600-does-dllstructgetdata-return-an-array-for-short-array/#comment-1374426
Here is my suggestion. Yes, I know it is long, but I don't see a way to make it both clear and short.
Here goes.
For Parameters > index, change to
"[optional or required] For elements that are in array format, specifies sub-element to retrieve. Applies only to elements that are in certain variable-type formats: see Remarks."
For Remarks, change to:
"This function never returns an array.
When an element is in char[n] or wchar[n] format, the data returned is a string.
When an element is in byte[n] format, the data returned is of binary type.
For any other element that is in array format, specifying index causes the function to return one scalar value. index specifies which. In this case, index is required. It is 1-based, so enter 1 for the first sub-element.
For elements in char[n], wchar[n] or byte[n] format, index is optional. Specifying it causes one character or byte to be retrieved. n is 1-based.
For any element that is not in an array format, index should not be specified.
For numeric formats (including byte format), Autoit always converts the value as specified by the element to the nearest Autoit type (e.g. for an element in byte format, an Int32 is returned; for float, a Double is returned).
Attachments (0)
Change History (4)
comment:1 Changed 7 years ago by BrewManNH
- Type changed from Bug to Feature Request
comment:2 Changed 7 years ago by TicketCleanup
- Version 3.3.15.0 deleted
comment:3 Changed 5 years ago by Jpm
- Owner set to BrewManNH
- Status changed from new to assigned
comment:4 Changed 4 years ago by Jpm
- Milestone set to 3.3.15.4
- Owner changed from BrewManNH to Jpm
- Resolution set to Fixed
- Status changed from assigned to closed
Fixed by revision [12369] in version: 3.3.15.4
Guidelines for posting comments:
- You cannot re-open a ticket but you may still leave a comment if you have additional information to add.
- In-depth discussions should take place on the forum.
For more information see the full version of the ticket guidelines here.
Automatic ticket cleanup.