ApiHelper generates Win32API code


Using APIHelper
Note:
Don't copy code directly from the boxes or the code won't
be automatically cleaned for you. Use the buttons labeled
"All", "Function", "Equates" and "UDT". You can set the
indentation with the "TABs" box (this is the number of TAB's
not spaces). There is also a "Copy" button for the
"SendMessage" builder.

1) Select a category from the combobox at the top of the
dialog. The listbox will fill with the items from that
category.

2) You can select the items you want to use from the list.
These can include one sub/function, numerous equates and
one UDT. Any extras will be ignored.

3) When you find and configure the code you want, you can
copy individual boxes or all of them at once.


Details
For subs and functions, the first one will be displayed
in the top box with its parameters, their types and equal
signs. You can fill in as many of the parameters as you
want, before copying to the clipboard. Some of these don't
have all their parameters listed yet and will be shown with
"( incomplete ! )" in the box.

Example:
= GetDefaultCommConfig(
pName As Asciz =
COMMCONFIG =
pSz As Dword =
) As Long

...after copying and pasting:
= GetDefaultCommConfig( , , )
   

Equates
For equates, all the selected ones will be displayed in
the 2nd box. They will be either "OR-ed", or in a "Select
Case" block, depending on the options chosen in the "Equate
Options" group. If you you choose "Automatic", it will make
a crude guess as to what's appropriate.


UDT's
For UDTs, the first one selected will be displayed in the
bottom box along with any of its members you've selected.
Any members from other UDT's will be ignored.
A variable of that type will be declared with your choice
of "Global", "Local", "Dim" or "Static". It's name will be
taken from the box labeled "Variable Name".
Equal signs will be placed before or after the members
depending on the option chosen. You can add assignment code
if you want before copying.
Some UDT's haven't been converted to PB yet and for those,
only the names are listed.

Example with equal signs placed afterward:
Dim UdtVar As COMMCONFIG
UdtVar.dwSize As Dword =
UdtVar.wVersion As Word =
UdtVar.wReserved As Word =
UdtVar.dcbx As DCB =
UdtVar.dwProviderSubType As Dword =
UdtVar.dwProviderOffset As Dword =
UdtVar.dwProviderSize As Dword =

Example with equal signs placed before:
Dim UdtVar As COMMCONFIG
= UdtVar.dwSize As Dword
= UdtVar.wVersion As Word
= UdtVar.wReserved As Word
= UdtVar.dcbx As DCB
= UdtVar.dwProviderSubType As Dword
= UdtVar.dwProviderOffset As Dword
= UdtVar.dwProviderSize As Dword

...after copying and pasting:
Dim UdtVar As COMMCONFIG
= UdtVar.dwSize
= UdtVar.wVersion
= UdtVar.wReserved
= UdtVar.dcbx
= UdtVar.dwProviderSubType
= UdtVar.dwProviderOffset
= UdtVar.dwProviderSize

The SendMessage Builder
The "SendMessage" builder will use the first equate
selected. If you click "Copy", a complete SendMessage" call
will be placed on the clipboard.

An example after pasting:
= SendMessage( hWnd, %CE_DNS, , )

    Miscellaneous:
Click "Deselect" to deselect all list items. Any code in
the boxes will be preserved.

Click "Help" (near the lower left corner) to show the help
file in the top box. It will be replaced by a function when
the next one's selected.

To turn tooltips on or off, click "Tooltips"




The ApiHelper source code is in the "apihelper" folder of the CVS directory
Browse CVS
Website Home
Project Summary Page at SourceForge.net






This project is sponsored by TheirCorp
(formerly TheirWare Corporation)