Modify

Opened 2 years ago

Last modified 2 weeks ago

#3579 assigned Feature Request

Clarification of Help for DllStructGetData(): never returns an array

Reported by: c.haslam Owned by: BrewManNH
Milestone: 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 (3)

comment:1 Changed 2 years ago by BrewManNH

  • Type changed from Bug to Feature Request

comment:2 Changed 2 years ago by TicketCleanup

  • Version 3.3.15.0 deleted

Automatic ticket cleanup.

comment:3 Changed 2 weeks ago by Jpm

  • Owner set to BrewManNH
  • Status changed from new to assigned

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.

Add Comment

Modify Ticket

Action
as assigned The owner will remain BrewManNH.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.