WinBatch Tech Support Home

Database Search

If you can't find the information using the categories below, post a question over in our WinBatch Tech Support Forum.

TechHome

How To
plus
plus
plus
plus
plus
plus
plus
plus
plus
plus
plus

Can't find the information you are looking for here? Then leave a message over on our WinBatch Tech Support Forum.

How to Locate functions in the help files


How to Locate Functions In Helpfiles

There are several products that use the WIL functions. The Windows Interfance Language Reference Manual / Windows Interface Language.chm are distributed with these products. This requires us to keep the Windows Interfance Language function documentation separate from the functions and utilities that are unique to WinBatch.

All of the functions and utilities that are unique to WinBatch are documented in the WinBatch Users Guide / WinBatch.chm. All of the Standard WIL functions are documented in the Windows Interfance Language Reference Manual and Windows Interface Language.chm. Any Extender functions are documented in their own respective .chm file.

WinBatch also includes a Consolidated WIL.chm help file that contains both the Windows Interface Language and WinBatch ,chm files as well as any other installed extender help files.


For Example, the 'Box' drawing functions are unique to WinBatch and are documented in the WinBatch Users Guide / WinBatch.chm file, *not* in the Big WIL (Windows Interface Language) manual or the Windows Interface Language.chm file.

This section includes only those additional WinBatch functions which do not appear in the WIL (Windows Interfance Language) Reference Manual.

WinBatch Specific Function List:

General WinBatch Functions

	BreakPoint
	

Generic Box Functions

	BoxOpen(title, text)
	BoxShut( )
	BoxText(text)
	BoxTitle(title)

Graphical Box Functions

The 'box' functions cannot be used with the Filemenu or Popmenu utilities. These WinBatch box functions generate attractive boxes with graphical interface elements. With a small number of primitive functions, very complex screens may be generated. The Box functions can draw lines, rectangles, circles, ellipses, text, and even additional windows on the screen. Plus they provide control over the size, placement, and color of the images.

Note: Another way to create graghical dialogs, is to use the WIL Dialog Editor. The WinBatch setup program uses WinBatch box functions to display the GUI part of the user interface. Additional "box" wbt files can be found in the Winbatch\ Samples directory.

	BoxBitmap(box ID, coordinates, filename, stretch-mode)
	BoxButtonDraw(box ID, button ID, text, coordinates)
	BoxButtonKill(box ID, button ID)
	BoxButtonStat(box ID, button ID)
	BoxButtonWait( )
	BoxCaption(box ID, caption)
	BoxColor(box ID, color, wash color)
	BoxDestroy(box ID)
	BoxDrawCircle(box ID, coordinates, style)
	BoxDrawLine(box ID, coordinates)
	BoxDrawRect(box ID, coordinates, style)
	BoxDrawText(box ID,coordinates,text,erase flag,alignment)
	BoxesUp(coordinates, show mode)
	BoxMapMode(box ID, map mode)
	BoxNew(box ID, coordinates, style)
	BoxPen(box ID, color, width)
	BoxTextColor(box ID, color)
	BoxTextFont(box ID, name, size, style, pitch & family)
	BoxUpdates(box ID, update flag)
	

Drawing Stack Management

	BoxDataClear(box ID, tag)
	BoxDataTag(box ID, tag)

Service Functions

If you want the WinBatch service to wait for a particular time or event to occur, you can use any of the normal WIL methods (TimeDelay, TimeWait, WinWaitExist, etc.). You can also use any of the following service functions:
	SvcSetAccept(codes)
	SvcSetState(state)
	SvcWaitForCmd(timeout)
	


Extender Functions

Each WIL Extender dll has its own individual help file. When the extender gets installed, a cooresponding help file gets installed to the WinBatch\System subdirectory. A shortcut to this help file gets created under the Winbatch program group in the Windows Start Menu.


WinBatch Studio

WinBatch Studio has some options to help look up various functions. The right-click context menu contains a "Help files" menu item that lists all of the various help files including installed extenders.

The right click context menu also contains a 'Keyword Lookup' option. You just highlight the function you want to look up the syntax for, right-click, then select "keyword Lookup" and the appropriate help file will be launched.


WinBatch Navigator

WinBatch Navigator offers a 'WinBatch Function Lookup' feature. If you know the name of the function you are looking for, you can type the function name into the 'WinBatch Function Lookup' edit field, then press search. This will search every installed help file for that function.

To launch WinBatch Navigator: go your Start Menu|Programs|WinBatch and run WinBatch.exe.


If you do not know the name of the function you are looking for: each help file contains a 'Find' tab. Select the 'Index' button near the top of the help file. Select the 'Find' tab, then type the keyword you are looking for. The help file will return a list of everything in that help file that applies to your search term.

If all else fails and you are unable to track down the necessary function, you might try doing a keyword search in our tech support database. Goto http://techsupt.winbatch.com. Type the keyword your interested in, then press search.

If you are still unable to track down a function...it probably doesn't exist. You may need to create your own function by creating your own User Defined Function. See the Windows Interface Language help file for more information about User Defined Functions. Or post a request to our Forums http://forum.winbatch.com.


Article ID:   W17935
Filename:   How to Locate functions in the help files.txt
File Created: 2013:06:19:13:43:18
Last Updated: 2013:06:19:13:43:18