R. E. Cook
Home 
Contact Us 

Dr. Cook
Resume 

RunningShoes Library for WinRunner 
RunningShoes 

Custom WinRunner Functions 
and Utilities,
to Your Specs
Custom 

A Random Collection of WinRunner Solutions
Solutions 

Creating DLLs for WinRunner 
"DLLs Demystified" 
(Mercury Interactive's Worldwide Users Conference 2000)

R. E. Cook Consulting

 


RunningShoes Documentation


The RunningShoes Library documentation is in the form of a Windows help file. In the current version, all functions are included (both C and TSL functions) and are fully documented. More than half of the functions have examples, totalling over 4600 lines of sample code (as of 25 October, 2005). The help files are of course included with the software. 

The help files are also available in a zip file so you can view them without installing the software, to avoid starting the trial period or just to skip the install process. Download the zipped help files (includes 2 files, RunningShoes.hlp and RunningShoes.cnt). For best results, unzip both files into the same folder, then open RunningShoes.hlp from there. Although you can open the file directly from within the zip file, the contents page will probably not be available, depending on how you unzip. The Windows XP unzip does not allow the contents to be displayed unless both files are unzipped first. Other unzip software might behave differently.

For the most part the parameters are named using the convention of Hungarian notation, and in most cases are (reasonably) self-explanatory. The following explanation describes the documentation.

The help page for each function displays the following information and layout (an example follows this description):


Function name()

Brief description

Function syntax (with parameters)

Parameter list. Each parameter is described in detail, along with its TSL mode (in, out, or inout) and C type (int, string, etc.). 

Description. This is a full, more-detailed description than given above. For just a few simple functions, this is just the brief description repeated, as no more description seems necessary. 

Return values (C type). The return values are described, along with the C type for the return value. TSL functions of course do not have a C type.

Example. More than half of the functions have examples in the current version, with more examples being added regularly. The documentation currently contains over 4000 lines of sample TSL code for using the library functions.

See also. Link to page with related functions.


A typical function's help page looks like this:


StringFormat()

Breaks the input string into lines, with each line no more than nLineLength characters.

StringFormat( lpszInputString, nLineLength );

lpszInputString  Contains the string to be formatted. (mode: in; C type: string)
nLineLength 
The requested maximum number of characters to include in a single line. Tokens longer than this will result in a line longer than requested, since tokens are not split. (mode: in; C type: int).

Breaks the input string into lines, and trims whitespace characters. Inserts line breaks ("\r\n") into the string as needed. The function attempts to limit each line to nLineLength characters. StringFormat() does not break tokens (groups of characters delimited by spaces). A token longer than nLineLength fills one line; that line is as long as the token.

StringFormat() also trims leading and trailing whitespace characters from each line, and extra whitespace characters within each line (equivalent to calling TrimWhiteSpace() on each resulting line). Whitespace includes the space, tab, linefeed, carriage-return, form-feed, vertical-tab, and newline characters.


Return values (C type: string)

Returns the string with line breaks.

Example

See also
 



Updated 10 November 2005



Top of  This Page | R. E. Cook Home Page

Copyright R. E. Cook Consulting, 2000 - 2011.
All rights reserved.

The site is designed to look best when viewed with Internet Explorer 5.0 - 8.0. Results with other browsers will probably deviate from what is intended.

NOTE: This website refers to registered trademarks and service marks that are owned by other companies, including Mercury Interactive, WinRunner, TestDirector, TSL, Microsoft, Windows.